Package com.sas.lsaf.core.type

Class Type

java.lang.Object
com.sas.lsaf.core.AbstractIdentifiable
com.sas.lsaf.core.type.TypeDescriptor
com.sas.lsaf.core.type.Type
All Implemented Interfaces:
Identifiable, Serializable
public class Type extends TypeDescriptor
A Type represents an object type that is defined in the system and that contains metadata that represents the state that is maintained by instances of this type. Types are immutable. Therefore, the initialized state is not modifiable. It not intended for these objects to be constructed. Rather, they should be retrieved using the TypeService.
Since:
1.7
See Also:

  • Constructor Details

    • Type

      public Type(String id, String name, String description, boolean contextType, boolean folderType, boolean sharedFolderType, boolean fileType, List<AttributeDefinition> attributeDefinitions, List<Type.Capability> capabilities, List<String> allowableChildTypes, long revision)
      It is not intended or recommended that the consumer of this API construct these objects. They should only deal with the type instances returned by the API.
      Parameters:
      id - the unique identifier of the type.
      name - the display name of the type.
      description - the description of the type.
      contextType - indicates whether the type is a context.
      folderType - indicates whether the type is a folder.
      sharedFolderType - indicates whether the type is a shared folder.
      fileType - indicates whether the type is a file.
      attributeDefinitions - the attribute definitions that define the attributes that can be stored with the object type.
      capabilities - the capabilities that are available with the type definition.
      allowableChildTypes - the list of allowable child types that can be created within the container type. The list is always empty for file types.
      revision - the internal revision number of the object.

  • Method Details

    • getRevision

      public long getRevision()
      Gets the internal revision number of the object.
      Returns:
      The internal revision number of the object.

    • getAttributeDefinitions

      public List<AttributeDefinition> getAttributeDefinitions()
      Gets the attribute definitions that are related to the object type. The list includes the system-defined attribute definitions and the user-defined extended attribute definitions.
      Returns:
      The attribute definitions that are related to the object type.

    • getAttributeDefinitionById

      public AttributeDefinition getAttributeDefinitionById(String id)
      Gets the attribute definition with the specified identifier. Returns null when the attribute definition is not declared on the type or any super type.
      Parameters:
      id - the identifier of the attribute definition to find.
      Returns:
      The attribute definition with the specified identifier or null, if one does not exist for the type.

    • getAttributeDefinitionByName

      public AttributeDefinition getAttributeDefinitionByName(String name)
      Gets the attribute definition with the specified name. Returns null when the attribute definition is not declared on the type or any super type.
      Parameters:
      name - the name of the attribute definition to find.
      Returns:
      The attribute definition with the specified name or null, if one does not exist for the type.

    • getCapabilities

      public List<Type.Capability> getCapabilities()
      Gets the capabilities that are available with the type definition.
      Returns:
      The capabilities that are available with the type definition.

    • getAllowableChildTypes

      public List<String> getAllowableChildTypes()
      Gets the list of allowable child types that can be created within the container type. The list will is always empty for file types.
      Returns:
      The list of allowable child types that can be created within the container type. The list is always empty for file types.

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class TypeDescriptor

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class TypeDescriptor

    • toString

      public String toString()
      Overrides:
      toString in class TypeDescriptor