LicenseProperties (Governance Program OMAS API 2.11 API)

java.lang.Object
- org.odpi.openmetadata.accessservices.governanceprogram.properties.LicenseProperties

All Implemented Interfaces:

Serializable
```
public class LicenseProperties
extends Object
implements Serializable
```
LicenseProperties describe the details of a license that shows that an element is licensed with a particular license type.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

LicenseProperties()
Default Constructor

LicenseProperties(LicenseProperties template)
Copy/clone Constructor - the resulting object.

Constructors
Constructor and Description
`LicenseProperties()` Default Constructor
`LicenseProperties(LicenseProperties template)` Copy/clone Constructor - the resulting object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object objectToCompare)` Equals method that returns true if containing properties are the same.
`String`	`getConditions()` Return any conditions or endorsements to this license.
`String`	`getCustodian()` Return the person/team responsible for ensuring that the license conditions are adhered to.
`String`	`getCustodianPropertyName()` Return the name of the property from the element supplying the custodian property.
`String`	`getCustodianTypeName()` Return the name of the type of the element supplying the custodian property.
`Date`	`getEndDate()` Return the date/time that this license is no longer valid.
`String`	`getLicensedBy()` Return the name of the person in the license authority that granted this license.
`String`	`getLicensedByPropertyName()` Return the name of the property from the element supplying the licensedBy property.
`String`	`getLicensedByTypeName()` Return the name of the type of the element supplying the licensedBy property.
`String`	`getLicensee()` Return the person/team that received the license.
`String`	`getLicenseePropertyName()` Return the name of the property from the element supplying the licensee property.
`String`	`getLicenseeTypeName()` Return the name of the type of the element supplying the licensee property.
`String`	`getLicenseId()` Return the unique identifier of the license.
`String`	`getNotes()` Return any notes associated with the license.
`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(String conditions)` Set up any conditions or endorsements to this license.
`void`	`setCustodian(String custodian)` Set up the person/team responsible for ensuring that the license conditions are adhered to.
`void`	`setCustodianPropertyName(String custodianPropertyName)` Set up the name of the property from the element supplying the custodian property.
`void`	`setCustodianTypeName(String custodianTypeName)` Set up the name of the type of the element supplying the custodian property.
`void`	`setEndDate(Date endDate)` Set up the date/time that this license is no longer valid.
`void`	`setLicensedBy(String licensedBy)` Set up the name of the person in the license authority that granted this license.
`void`	`setLicensedByPropertyName(String licensedByPropertyName)` Set up the name of the property from the element supplying the licensedBy property.
`void`	`setLicensedByTypeName(String licensedByTypeName)` Set up the name of the type of the element supplying the licensedBy property.
`void`	`setLicensee(String licensee)` Set up the person/team that received the license.
`void`	`setLicenseePropertyName(String licenseePropertyName)` Set up the name of the property from the element supplying the licensee property.
`void`	`setLicenseeTypeName(String licenseeTypeName)` Set up the name of the type of the element supplying the licensee property.
`void`	`setLicenseId(String licenseId)` Set up the unique identifier of the license.
`void`	`setNotes(String notes)` Set up any notes associated with the license.
`void`	`setStartDate(Date startDate)` Set up the date/time that this license is valid from.
`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 String getLicenseId()
```
    Return the unique identifier of the license. This value comes from the license authority.
    
    Returns:
    
    string
  - setLicenseId
```
public void setLicenseId(String licenseId)
```
    Set up the unique identifier of the license. This value comes from the license authority.
    
    Parameters:
    
    licenseId - string
  - getStartDate
```
public Date getStartDate()
```
    Return the date/time that this license is valid from.
    
    Returns:
    
    date/time
  - setStartDate
```
public void setStartDate(Date startDate)
```
    Set up the date/time that this license is valid from.
    
    Parameters:
    
    startDate - date/time
  - getEndDate
```
public Date getEndDate()
```
    Return the date/time that this license is no longer valid.
    
    Returns:
    
    date/time
  - setEndDate
```
public void setEndDate(Date endDate)
```
    Set up the date/time that this license is no longer valid.
    
    Parameters:
    
    endDate - date/time
  - getConditions
```
public String getConditions()
```
    Return any conditions or endorsements to this license.
    
    Returns:
    
    string text
  - setConditions
```
public void setConditions(String conditions)
```
    Set up any conditions or endorsements to this license.
    
    Parameters:
    
    conditions - string text
  - getLicensedBy
```
public String getLicensedBy()
```
    Return the name of the person in the license authority that granted this license.
    
    Returns:
    
    string name/id
  - setLicensedBy
```
public void setLicensedBy(String licensedBy)
```
    Set up the name of the person in the license authority that granted this license.
    
    Parameters:
    
    licensedBy - string name/id
  - getLicensedByTypeName
```
public String getLicensedByTypeName()
```
    Return the name of the type of the element supplying the licensedBy property.
    
    Returns:
    
    string type name
  - setLicensedByTypeName
```
public void setLicensedByTypeName(String licensedByTypeName)
```
    Set up the name of the type of the element supplying the licensedBy property.
    
    Parameters:
    
    licensedByTypeName - string type name
  - getLicensedByPropertyName
```
public String getLicensedByPropertyName()
```
    Return the name of the property from the element supplying the licensedBy property.
    
    Returns:
    
    string property name
  - setLicensedByPropertyName
```
public void setLicensedByPropertyName(String licensedByPropertyName)
```
    Set up the name of the property from the element supplying the licensedBy property.
    
    Parameters:
    
    licensedByPropertyName - string property name
  - getCustodian
```
public String getCustodian()
```
    Return the person/team responsible for ensuring that the license conditions are adhered to.
    
    Returns:
    
    string name/id
  - setCustodian
```
public void setCustodian(String custodian)
```
    Set up the person/team responsible for ensuring that the license conditions are adhered to.
    
    Parameters:
    
    custodian - string name/id
  - getCustodianTypeName
```
public String getCustodianTypeName()
```
    Return the name of the type of the element supplying the custodian property.
    
    Returns:
    
    string type name
  - setCustodianTypeName
```
public void setCustodianTypeName(String custodianTypeName)
```
    Set up the name of the type of the element supplying the custodian property.
    
    Parameters:
    
    custodianTypeName - string type name
  - getCustodianPropertyName
```
public String getCustodianPropertyName()
```
    Return the name of the property from the element supplying the custodian property.
    
    Returns:
    
    string property name
  - setCustodianPropertyName
```
public void setCustodianPropertyName(String custodianPropertyName)
```
    Set up the name of the property from the element supplying the custodian property.
    
    Parameters:
    
    custodianPropertyName - string property name
  - getLicensee
```
public String getLicensee()
```
    Return the person/team that received the license.
    
    Returns:
    
    string name/id
  - setLicensee
```
public void setLicensee(String licensee)
```
    Set up the person/team that received the license.
    
    Parameters:
    
    licensee - string name/id
  - getLicenseeTypeName
```
public String getLicenseeTypeName()
```
    Return the name of the type of the element supplying the licensee property.
    
    Returns:
    
    string type name
  - setLicenseeTypeName
```
public void setLicenseeTypeName(String licenseeTypeName)
```
    Set up the name of the type of the element supplying the licensee property.
    
    Parameters:
    
    licenseeTypeName - string type name
  - getLicenseePropertyName
```
public String getLicenseePropertyName()
```
    Return the name of the property from the element supplying the licensee property.
    
    Returns:
    
    string property name
  - setLicenseePropertyName
```
public void setLicenseePropertyName(String licenseePropertyName)
```
    Set up the name of the property from the element supplying the licensee property.
    
    Parameters:
    
    licenseePropertyName - string property name
  - getNotes
```
public String getNotes()
```
    Return any notes associated with the license.
    
    Returns:
    
    string text
  - setNotes
```
public void setNotes(String notes)
```
    Set up any notes associated with the license.
    
    Parameters:
    
    notes - string text
  - toString
```
public String toString()
```
    JSON-style toString.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    list of properties and their values.
  - equals
```
public boolean equals(Object objectToCompare)
```
    Equals method that returns true if containing properties are the same.
    
    Overrides:
    
    equals in class Object
    
    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 Object
    
    Returns:
    
    int code

Class LicenseProperties

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LicenseProperties

LicenseProperties

Method Detail

getLicenseId

setLicenseId

getStartDate

setStartDate

getEndDate

setEndDate

getConditions

setConditions

getLicensedBy

setLicensedBy

getLicensedByTypeName

setLicensedByTypeName

getLicensedByPropertyName

setLicensedByPropertyName

getCustodian

setCustodian

getCustodianTypeName

setCustodianTypeName

getCustodianPropertyName

setCustodianPropertyName

getLicensee

setLicensee

getLicenseeTypeName

setLicenseeTypeName

getLicenseePropertyName

setLicenseePropertyName

getNotes

setNotes

toString

equals

hashCode