public interface TypeService
Type
instances represent object metadata information for objects within the system. This service allows
retrieval of Type
instances so information about the object and the AttributeDefinition
details that
describe what information is stored with the object. The AttributeDefinition
details include attribute
definitions that are system-defined and user-defined extended attributes.
The primary use case for this service is to retrieve information that is related to user-defined extended attributes. Because of this fact, the types that are surfaced through this service are the object types that can be extended with custom attribute definitions. All other types are suppressed. This is the identical behavior that is surfaced through the application.
Currently, the type information is immutable. So, the information provided by this service is read-only.
Type
,
AttributeDefinition
Modifier and Type | Method and Description |
---|---|
List<Type> |
getAuditableTypes()
Gets all the type definitions that are audited in the system.
|
List<Type> |
getContextTypes()
Gets all of the type definitions that are repository contexts in the system.
|
List<Type> |
getSearchableTypes()
Gets all the type definitions that can be searched in the system.
|
List<TypeDescriptor> |
getTopLevelTypes()
Retrieve all type definitions that are repository contexts that have
Type.Capability.TOP in the system. |
Type |
getTypeById(String id)
Gets the
Type with the specified unique identifier. |
List<Type> |
getTypes()
Gets all the type definitions in the system.
|
List<Type> |
getTypesByCapability(Type.Capability capability)
Retrieve all type definitions that have the specified capability
Type.Capability in the system. |
boolean |
isTypeCapable(String id,
Type.Capability capability)
Indicates whether the capability is available at the specified type.
|
boolean |
typeExists(String id)
Indicates whether a
Type with the specified unique identifier exists within the system. |
boolean typeExists(String id)
Type
with the specified unique identifier exists within the system.id
- the unique identifier to search for.True
, if the type definition exists, False
otherwise.Type getTypeById(String id) throws TypeNotFoundException
Type
with the specified unique identifier. If the Type
does not exist, a
TypeNotFoundException
is thrown.id
- the unique identifier to search for.TypeNotFoundException
- thrown when the type definition does not exist.List<Type> getTypes()
List<Type> getSearchableTypes()
List<Type> getAuditableTypes()
List<Type> getContextTypes()
List<TypeDescriptor> getTopLevelTypes()
Type.Capability.TOP
in the system.Type.Capability.TOP
in the system.List<Type> getTypesByCapability(Type.Capability capability)
Type.Capability
in the system.capability
- the capability of the type definition.Type.Capability
in the system.boolean isTypeCapable(String id, Type.Capability capability)
id
- the unique identifier to search for.capability
- the capability of the type definition.boolean
value that indicates whether the type has the capability.<i>Copyright (c) 2020, SAS Institute Inc., Cary, NC, USA</i>