com.sas.hls.type
Interface TypeService


public interface TypeService

A service for retrieving object type information for objects stored in the system.

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.

Since:
1.7
See Also:
Type, AttributeDefinition

Method Summary
 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.
 

Method Detail

typeExists

boolean typeExists(String name)
Determine whether a Type with the specified name exists within the system.

Parameters:
name - The name of the object type to check.
Returns:
true if the object type exists with the specified name, false otherwise.
Since:
1.7

getTypeByName

Type getTypeByName(String name)
                   throws TypeNotFoundException
Retrieve the Type with the specified name. If the Type does not exist a TypeNotFoundException is thrown.

Parameters:
name - The name of the object type to retrieve.
Returns:
The Type if it exists.
Throws:
TypeNotFoundException - Thrown if the object type does not exist.
Since:
1.7

getTypes

List<Type> getTypes()
Retrieve all Type instances in the system.

Returns:
A List of all Type objects defined in the system.
Since:
1.7


Copyright (c) 2016, SAS Institute Inc., Cary, NC, USA