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 are stored with the object can be reviewed. The AttributeDefinition
details include attribute
definitions that are system-defined as well as user-defined extended attributes.
The primary use-case for this service is to retrieve information related to user-defined extended attributes. Because of this, 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 a read-only.
Type
,
AttributeDefinition
Modifier and Type | Method and Description |
---|---|
Type |
getTypeByName(String name)
Retrieve the
Type with the specified name. |
List<Type> |
getTypes()
Retrieve all
Type instances in the system. |
boolean |
typeExists(String name)
Determine whether a
Type with the specified name exists within the system. |
boolean typeExists(String name)
Type
with the specified name exists within the system.name
- The name of the object type to check.true
if the object type exists with the specified name, false
otherwise.Type getTypeByName(String name) throws TypeNotFoundException
Type
with the specified name. If the Type
does not exist a
TypeNotFoundException
is thrown.name
- The name of the object type to retrieve.Type
if it exists.TypeNotFoundException
- Thrown if the object type does not exist.Copyright (c) 2017, SAS Institute Inc., Cary, NC, USA