Class CollectionProperties
java.lang.Object
org.odpi.openmetadata.accessservices.digitalservice.properties.ReferenceableProperties
org.odpi.openmetadata.accessservices.digitalservice.properties.CollectionProperties
- All Implemented Interfaces:
Serializable
CollectionProperties describes the core properties of a collection.
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructorCollectionProperties
(CollectionProperties template) Copy/clone constructor -
Method Summary
Modifier and TypeMethodDescriptionboolean
Return comparison result based on the content of the properties.Return the property to use to determine the order that assets are returned.Return the description of the collection.getName()
Return the name of the collection.Return the property name for CollectionOrder.OTHER.int
hashCode()
Return hash code for this objectvoid
setCollectionOrdering
(CollectionOrder collectionOrdering) Set up the property to use to determine the order that assets are returned.void
setDescription
(String description) Set up the description of the collection.void
Set up the name of the collection.void
setOrderPropertyName
(String orderPropertyName) Set up the property name for CollectionOrder.OTHER.toString()
JSON-style toStringMethods inherited from class org.odpi.openmetadata.accessservices.digitalservice.properties.ReferenceableProperties
getAdditionalProperties, getEffectiveFrom, getEffectiveTo, getExtendedProperties, getQualifiedName, getTypeName, setAdditionalProperties, setEffectiveFrom, setEffectiveTo, setExtendedProperties, setQualifiedName, setTypeName
-
Constructor Details
-
CollectionProperties
public CollectionProperties()Default constructor -
CollectionProperties
Copy/clone constructor- Parameters:
template
- object to copy
-
-
Method Details
-
getName
Return the name of the collection.- Returns:
- string name
-
setName
Set up the name of the collection.- Parameters:
name
- string name
-
getDescription
Return the description of the collection.- Returns:
- text
-
setDescription
Set up the description of the collection.- Parameters:
description
- text
-
getCollectionOrdering
Return the property to use to determine the order that assets are returned.- Returns:
- CollectionOrder enum
-
setCollectionOrdering
Set up the property to use to determine the order that assets are returned.- Parameters:
collectionOrdering
- CollectionOrder enum
-
getOrderPropertyName
Return the property name for CollectionOrder.OTHER.- Returns:
- string property name
-
setOrderPropertyName
Set up the property name for CollectionOrder.OTHER.- Parameters:
orderPropertyName
- string property name
-
toString
JSON-style toString- Overrides:
toString
in classReferenceableProperties
- Returns:
- return string containing the property names and values
-
equals
Return comparison result based on the content of the properties.- Overrides:
equals
in classReferenceableProperties
- Parameters:
objectToCompare
- test object- Returns:
- result of comparison
-
hashCode
public int hashCode()Return hash code for this object- Overrides:
hashCode
in classReferenceableProperties
- Returns:
- int hash code
-