Class LicenseProperties

  • All Implemented Interfaces:
    java.io.Serializable

    public class LicenseProperties
    extends RelationshipProperties
    LicenseProperties describe the details of a license that shows that an element is licensed with a particular license type.
    See Also:
    Serialized Form
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object objectToCompare)
      Equals method that returns true if containing properties are the same.
      java.lang.String getConditions()
      Return any conditions or endorsements to this license.
      java.lang.String getCustodian()
      Return the person/team responsible for ensuring that the license conditions are adhered to.
      java.lang.String getCustodianPropertyName()
      Return the name of the property from the element supplying the custodian property.
      java.lang.String getCustodianTypeName()
      Return the name of the type of the element supplying the custodian property.
      java.util.Date getEndDate()
      Return the date/time that this license is no longer valid.
      java.util.Map<java.lang.String,​java.lang.String> getEntitlements()
      Return the entitlements granted by the license.
      java.lang.String getLicensedBy()
      Return the name of the person in the license authority that granted this license.
      java.lang.String getLicensedByPropertyName()
      Return the name of the property from the element supplying the licensedBy property.
      java.lang.String getLicensedByTypeName()
      Return the name of the type of the element supplying the licensedBy property.
      java.lang.String getLicensee()
      Return the person/team that received the license.
      java.lang.String getLicenseePropertyName()
      Return the name of the property from the element supplying the licensee property.
      java.lang.String getLicenseeTypeName()
      Return the name of the type of the element supplying the licensee property.
      java.lang.String getLicenseId()
      Return the unique identifier of the license.
      java.lang.String getNotes()
      Return any notes associated with the license.
      java.util.Map<java.lang.String,​java.lang.String> getObligations()
      Return the obligations stipulated by the license.
      java.util.Map<java.lang.String,​java.lang.String> getRestrictions()
      Return the restrictions imposed by the license.
      java.util.Date getStartDate()
      Return the date/time that this license is valid from.
      int hashCode()
      Just use the GUID for the hash code as it should be unique.
      void setConditions​(java.lang.String conditions)
      Set up any conditions or endorsements to this license.
      void setCustodian​(java.lang.String custodian)
      Set up the person/team responsible for ensuring that the license conditions are adhered to.
      void setCustodianPropertyName​(java.lang.String custodianPropertyName)
      Set up the name of the property from the element supplying the custodian property.
      void setCustodianTypeName​(java.lang.String custodianTypeName)
      Set up the name of the type of the element supplying the custodian property.
      void setEndDate​(java.util.Date endDate)
      Set up the date/time that this license is no longer valid.
      void setEntitlements​(java.util.Map<java.lang.String,​java.lang.String> entitlements)
      Set up the entitlements granted by the license.
      void setLicensedBy​(java.lang.String licensedBy)
      Set up the name of the person in the license authority that granted this license.
      void setLicensedByPropertyName​(java.lang.String licensedByPropertyName)
      Set up the name of the property from the element supplying the licensedBy property.
      void setLicensedByTypeName​(java.lang.String licensedByTypeName)
      Set up the name of the type of the element supplying the licensedBy property.
      void setLicensee​(java.lang.String licensee)
      Set up the person/team that received the license.
      void setLicenseePropertyName​(java.lang.String licenseePropertyName)
      Set up the name of the property from the element supplying the licensee property.
      void setLicenseeTypeName​(java.lang.String licenseeTypeName)
      Set up the name of the type of the element supplying the licensee property.
      void setLicenseId​(java.lang.String licenseId)
      Set up the unique identifier of the license.
      void setNotes​(java.lang.String notes)
      Set up any notes associated with the license.
      void setObligations​(java.util.Map<java.lang.String,​java.lang.String> obligations)
      Set up the obligations stipulated by the license.
      void setRestrictions​(java.util.Map<java.lang.String,​java.lang.String> restrictions)
      Set up the restrictions imposed by the license.
      void setStartDate​(java.util.Date startDate)
      Set up the date/time that this license is valid from.
      java.lang.String toString()
      JSON-style toString.
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • LicenseProperties

        public LicenseProperties()
        Default Constructor
      • LicenseProperties

        public LicenseProperties​(LicenseProperties template)
        Copy/clone Constructor - the resulting object.
        Parameters:
        template - object being copied
    • Method Detail

      • getLicenseId

        public java.lang.String getLicenseId()
        Return the unique identifier of the license. This value comes from the license authority.
        Returns:
        string
      • setLicenseId

        public void setLicenseId​(java.lang.String licenseId)
        Set up the unique identifier of the license. This value comes from the license authority.
        Parameters:
        licenseId - string
      • getStartDate

        public java.util.Date getStartDate()
        Return the date/time that this license is valid from.
        Returns:
        date/time
      • setStartDate

        public void setStartDate​(java.util.Date startDate)
        Set up the date/time that this license is valid from.
        Parameters:
        startDate - date/time
      • getEndDate

        public java.util.Date getEndDate()
        Return the date/time that this license is no longer valid.
        Returns:
        date/time
      • setEndDate

        public void setEndDate​(java.util.Date endDate)
        Set up the date/time that this license is no longer valid.
        Parameters:
        endDate - date/time
      • getConditions

        public java.lang.String getConditions()
        Return any conditions or endorsements to this license.
        Returns:
        string text
      • setConditions

        public void setConditions​(java.lang.String conditions)
        Set up any conditions or endorsements to this license.
        Parameters:
        conditions - string text
      • getLicensedBy

        public java.lang.String getLicensedBy()
        Return the name of the person in the license authority that granted this license.
        Returns:
        string name/id
      • setLicensedBy

        public void setLicensedBy​(java.lang.String licensedBy)
        Set up the name of the person in the license authority that granted this license.
        Parameters:
        licensedBy - string name/id
      • getLicensedByTypeName

        public java.lang.String getLicensedByTypeName()
        Return the name of the type of the element supplying the licensedBy property.
        Returns:
        string type name
      • setLicensedByTypeName

        public void setLicensedByTypeName​(java.lang.String licensedByTypeName)
        Set up the name of the type of the element supplying the licensedBy property.
        Parameters:
        licensedByTypeName - string type name
      • getLicensedByPropertyName

        public java.lang.String getLicensedByPropertyName()
        Return the name of the property from the element supplying the licensedBy property.
        Returns:
        string property name
      • setLicensedByPropertyName

        public void setLicensedByPropertyName​(java.lang.String licensedByPropertyName)
        Set up the name of the property from the element supplying the licensedBy property.
        Parameters:
        licensedByPropertyName - string property name
      • getCustodian

        public java.lang.String getCustodian()
        Return the person/team responsible for ensuring that the license conditions are adhered to.
        Returns:
        string name/id
      • setCustodian

        public void setCustodian​(java.lang.String custodian)
        Set up the person/team responsible for ensuring that the license conditions are adhered to.
        Parameters:
        custodian - string name/id
      • getCustodianTypeName

        public java.lang.String getCustodianTypeName()
        Return the name of the type of the element supplying the custodian property.
        Returns:
        string type name
      • setCustodianTypeName

        public void setCustodianTypeName​(java.lang.String custodianTypeName)
        Set up the name of the type of the element supplying the custodian property.
        Parameters:
        custodianTypeName - string type name
      • getCustodianPropertyName

        public java.lang.String getCustodianPropertyName()
        Return the name of the property from the element supplying the custodian property.
        Returns:
        string property name
      • setCustodianPropertyName

        public void setCustodianPropertyName​(java.lang.String custodianPropertyName)
        Set up the name of the property from the element supplying the custodian property.
        Parameters:
        custodianPropertyName - string property name
      • getLicensee

        public java.lang.String getLicensee()
        Return the person/team that received the license.
        Returns:
        string name/id
      • setLicensee

        public void setLicensee​(java.lang.String licensee)
        Set up the person/team that received the license.
        Parameters:
        licensee - string name/id
      • getLicenseeTypeName

        public java.lang.String getLicenseeTypeName()
        Return the name of the type of the element supplying the licensee property.
        Returns:
        string type name
      • setLicenseeTypeName

        public void setLicenseeTypeName​(java.lang.String licenseeTypeName)
        Set up the name of the type of the element supplying the licensee property.
        Parameters:
        licenseeTypeName - string type name
      • getLicenseePropertyName

        public java.lang.String getLicenseePropertyName()
        Return the name of the property from the element supplying the licensee property.
        Returns:
        string property name
      • setLicenseePropertyName

        public void setLicenseePropertyName​(java.lang.String licenseePropertyName)
        Set up the name of the property from the element supplying the licensee property.
        Parameters:
        licenseePropertyName - string property name
      • getEntitlements

        public java.util.Map<java.lang.String,​java.lang.String> getEntitlements()
        Return the entitlements granted by the license.
        Returns:
        name value pairs
      • setEntitlements

        public void setEntitlements​(java.util.Map<java.lang.String,​java.lang.String> entitlements)
        Set up the entitlements granted by the license.
        Parameters:
        entitlements - name value pairs
      • getRestrictions

        public java.util.Map<java.lang.String,​java.lang.String> getRestrictions()
        Return the restrictions imposed by the license.
        Returns:
        name value pairs
      • setRestrictions

        public void setRestrictions​(java.util.Map<java.lang.String,​java.lang.String> restrictions)
        Set up the restrictions imposed by the license.
        Parameters:
        restrictions - name value pairs
      • getObligations

        public java.util.Map<java.lang.String,​java.lang.String> getObligations()
        Return the obligations stipulated by the license.
        Returns:
        name value pairs
      • setObligations

        public void setObligations​(java.util.Map<java.lang.String,​java.lang.String> obligations)
        Set up the obligations stipulated by the license.
        Parameters:
        obligations - name value pairs
      • getNotes

        public java.lang.String getNotes()
        Return any notes associated with the license.
        Returns:
        string text
      • setNotes

        public void setNotes​(java.lang.String notes)
        Set up any notes associated with the license.
        Parameters:
        notes - string text
      • toString

        public java.lang.String toString()
        JSON-style toString.
        Overrides:
        toString in class RelationshipProperties
        Returns:
        list of properties and their values.
      • equals

        public boolean equals​(java.lang.Object objectToCompare)
        Equals method that returns true if containing properties are the same.
        Overrides:
        equals in class RelationshipProperties
        Parameters:
        objectToCompare - object to compare
        Returns:
        boolean result of comparison
      • hashCode

        public int hashCode()
        Just use the GUID for the hash code as it should be unique.
        Overrides:
        hashCode in class RelationshipProperties
        Returns:
        int code