Package com.emc.documentum.rest.dfc
Interface TypeManager
public interface TypeManager
interface to manage type
-
Method Summary
Modifier and TypeMethodDescriptiongetCustomAttributes
(String type) get custom type attribute the assumption is custom type won't start with dm_ for any type start with dm_, nothing will be returnedgetTypeDefinition
(com.documentum.fc.client.IDfSession session, String type, AttributeView attrAttributeView, boolean inherited, boolean convertType) Deprecated.getTypeDefinition
(com.documentum.fc.client.IDfSession session, String type, String locale, boolean inherited, boolean convertAttrType) Deprecated.getTypeDefinition
(com.documentum.fc.client.IDfSession session, String type, String locale, boolean inherited, boolean convertAttrType, String policyId, String state, boolean includeVA) Deprecated.getTypeDefinition
(com.documentum.fc.client.IDfTypedObject dfType, AttributeView attrAttributeView, boolean inherited, boolean convertType) Deprecated.getTypeDefinition
(com.documentum.fc.client.IDfTypedObject dfType, TypeParameter typeParameter) get the type definition by the query result against the dm_type only only basic attribute can be included, all other DD info won't be added no extra query will be executedgetTypeDefinition
(String type, AttributeView attrAttributeView, boolean inherited, boolean convertType) Deprecated.getTypeDefinition
(String type, TypeParameter typeParameter) get the type definitiongetTypeDefinition
(String type, String locale, boolean inherited, boolean convertAttrType) Deprecated.getTypeDefinition
(String type, String locale, boolean inherited, boolean convertAttrType, String policyId, String state, boolean includeVA) Deprecated.
-
Method Details
-
getTypeDefinition
@Deprecated TypeObject getTypeDefinition(String type, String locale, boolean inherited, boolean convertAttrType, String policyId, String state, boolean includeVA) throws com.documentum.fc.common.DfException Deprecated.Get type definition specified by the type name- Parameters:
type
- the type namelocale
- the label localeinherited
- true, show inherited properties, otherwise, only show non-inherited propertiesconvertAttrType
- whether convert typepolicyId
- the id of life-cycle policy objectstate
- the state name of life-cycleincludeVA
- whether include value assist definition- Returns:
- the type definition
- Throws:
com.documentum.fc.common.DfException
- exception during the operation
-
getTypeDefinition
@Deprecated TypeObject getTypeDefinition(String type, String locale, boolean inherited, boolean convertAttrType) throws com.documentum.fc.common.DfException Deprecated.Get type definition specified by the type name- Parameters:
type
- the type namelocale
- the label localeinherited
- true, show inherited properties, otherwise, only show non-inherited propertiesconvertAttrType
- whether convert type- Returns:
- the type definition
- Throws:
com.documentum.fc.common.DfException
- exception during the operation
-
getTypeDefinition
@Deprecated TypeObject getTypeDefinition(com.documentum.fc.client.IDfSession session, String type, String locale, boolean inherited, boolean convertAttrType, String policyId, String state, boolean includeVA) throws com.documentum.fc.common.DfException Deprecated.Get type definition specified by the type name with session- Parameters:
session
- the dfc sessiontype
- the type namelocale
- the label localeinherited
- true, show inherited properties, otherwise, only show non-inherited propertiesconvertAttrType
- whether convert typepolicyId
- the id of life-cycle policy objectstate
- the state name of life-cycleincludeVA
- whether include value assist definition- Returns:
- the type definition
- Throws:
com.documentum.fc.common.DfException
- exception during the operation
-
getTypeDefinition
@Deprecated TypeObject getTypeDefinition(com.documentum.fc.client.IDfSession session, String type, String locale, boolean inherited, boolean convertAttrType) throws com.documentum.fc.common.DfException Deprecated.Get type definition specified by the type name with session- Parameters:
session
- the dfc sessiontype
- the type namelocale
- the label localeinherited
- true, show inherited properties, otherwise, only show non-inherited propertiesconvertAttrType
- whether convert type- Returns:
- the type definition
- Throws:
com.documentum.fc.common.DfException
- exception during the operation
-
getTypeDefinition
@Deprecated TypeObject getTypeDefinition(String type, AttributeView attrAttributeView, boolean inherited, boolean convertType) throws com.documentum.fc.common.DfException Deprecated.Get type definition specified by the type name with session The returned result only contains info from dm_type The type property's attributes is controlled by attributeView. AttributeView.NONE will return attr_name only, others return all available property attributes- Parameters:
type
- the type nameattrAttributeView
- the attribute viewinherited
- indicates whether to include inherited attributes.true
to include inherited attributes.convertType
- whether convert type- Returns:
- the type definition
- Throws:
com.documentum.fc.common.DfException
- exception during the operation
-
getTypeDefinition
@Deprecated TypeObject getTypeDefinition(com.documentum.fc.client.IDfSession session, String type, AttributeView attrAttributeView, boolean inherited, boolean convertType) throws com.documentum.fc.common.DfException Deprecated.Get type definition specified by the type name with session The returned result only contains info from dm_type The type property's attributes is controlled by attributeView. AttributeView.NONE will return attr_name only, others return all available property attributes- Parameters:
session
- the DFC sessiontype
- the type nameattrAttributeView
- the attribute viewinherited
- indicates whether to include inherited attributes.true
to include inherited attributes.convertType
- whether convert type- Returns:
- the type definition
- Throws:
com.documentum.fc.common.DfException
- exception during the operation
-
getTypeDefinition
@Deprecated TypeObject getTypeDefinition(com.documentum.fc.client.IDfTypedObject dfType, AttributeView attrAttributeView, boolean inherited, boolean convertType) throws com.documentum.fc.common.DfException Deprecated.Get type definition specified by the type name with session The returned result only contains info from dm_type The type property's attributes is controlled by attributeView. AttributeView.NONE will return attr_name only, others return all available property attributes- Parameters:
dfType
- the dfc type objectattrAttributeView
- the attribute viewinherited
- indicates whether to include inherited attributes.true
to include inherited attributes.convertType
- whether convert type- Returns:
- the type definition
- Throws:
com.documentum.fc.common.DfException
- exception during the operation
-
getCustomAttributes
get custom type attribute the assumption is custom type won't start with dm_ for any type start with dm_, nothing will be returned- Parameters:
type
- the type name- Returns:
- custom attribute name
- Throws:
com.documentum.fc.common.DfException
- exception during the operation
-
getTypeDefinition
TypeObject getTypeDefinition(String type, TypeParameter typeParameter) throws com.documentum.fc.common.DfException get the type definition- Parameters:
type
- the type nametypeParameter
- theTypeParameter
used when getting the type definition- Returns:
- the type definition
- Throws:
com.documentum.fc.common.DfException
- exception during the operation
-
getTypeDefinition
TypeObject getTypeDefinition(com.documentum.fc.client.IDfTypedObject dfType, TypeParameter typeParameter) throws com.documentum.fc.common.DfException get the type definition by the query result against the dm_type only only basic attribute can be included, all other DD info won't be added no extra query will be executed- Parameters:
dfType
- the query resulttypeParameter
- theTypeParameter
used when getting the type definition- Returns:
- the type definition
- Throws:
com.documentum.fc.common.DfException
- exception during the operation
-
getTypeDefinition(String, TypeParameter)