IGCRestConstants (IBM Information Governance Catalog REST API Client Library 2.11 API)

java.lang.Object
- org.odpi.egeria.connectors.ibm.igc.clientlibrary.IGCRestConstants

public class IGCRestConstants
extends Object

Set of constants for IGC REST API usage.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CLASSIFICATIONENABLEDGROUP`
`static Pattern`	`COOKIE_WHITELIST`
`static String`	`IGC_REST_BASE_MODEL_PKG`
`static String`	`IGC_REST_COMMON_MODEL_PKG`
`static String`	`INFORMATION_ASSET`
`static String`	`MAIN_OBJECT`
`static String`	`MOD_CREATED_BY`
`static String`	`MOD_CREATED_ON`
`static String`	`MOD_MODIFIED_BY`
`static String`	`MOD_MODIFIED_ON`
`static Pattern`	`NAMING_CHAR_WHITELIST`
`static String`	`NON_IGC_PREFIX`
`static String`	`NOTE`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static String`	`getAssetTypeForSearch(String assetType)` Translates the type of asset into what should be used for searching.
`static String`	`getCamelCase(String input)` Converts an IGC type or property (something_like_this) into a camelcase class name (SomethingLikeThis).
`static String`	`getClassNameForAssetType(String igcAssetType)` Retrieve the name of a POJO class from the IGC asset type name.
`static IGCSearchCondition`	`getConditionToForceNoSearchResults()` Retrieve a search condition that will ensure no results are returned from a search.
`static Set<String>`	`getDatastageSpecificTypes()` Retrieve the set of DataStage-specific asset types.
`static List<String>`	`getFileTypes()` Retrieve a list of the asset types that deal with files in some way.
`static Set<String>`	`getFixedInformationAssetProperties()` Retrieve the list of properties that should be fixed at the Information Asset object level.
`static Set<String>`	`getFixedMainObjectProperties()` Retrieve the list of properties that should be fixed at the Main Object level.
`static String`	`getGetterNameForProperty(String propertyName)` Retrieve the getter name for the specified property.
`static Map<String,String>`	`getImamTypeToIgcType()` Retrieve a mapping from IMAM type name to IGC type name.
`static String`	`getJavaTypeForProperty(TypeProperty property)` Retrieve the name of the Java type for the provided IGC type.
`static String`	`getLowerCamelCase(String input)` Converts an IGC type or property (something_like_this) into lower a camelcase name (somethingLikeThis).
`static List<String>`	`getModificationProperties()` Retrieve a list of the modification detail properties used by the IGC REST API.
`static Set<String>`	`getPropertiesToIgnore()` Retrieve the set of properties that should be ignored for all assets.
`static Set<String>`	`getRelationshipLevelTypes()` Retrieve a set of IGC asset types that are actual relationship-level assets (very rare).
`static String`	`getSetterNameForProperty(String propertyName)` Retrieve the setter name for the specified property.
`static Map<String,String>`	`getSubTypeToSuperType()` Retrieve the mapping of IGC object sub-types to granular super-types.
`static List<String>`	`getSuperTypes()` Retrieve the list of IGC object super types, in order from the highest level of abstraction to lower levels of granularity.
`static Set<String>`	`getTypesThatCannotBeSearched()` Retrieve the set of IGC object types that cannot be searched for via the IGC REST API.
`static List<String>`	`getUserTypes()` Retrieve a list of the asset types that deal with users in some way.
`static Set<String>`	`getValidCookieNames()` Retrieve the set of valid cookie names for the IGC REST API.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NON_IGC_PREFIX
```
public static final String NON_IGC_PREFIX
```
    See Also:
    
    Constant Field Values
  - MOD_CREATED_BY
```
public static final String MOD_CREATED_BY
```
    See Also:
    
    Constant Field Values
  - MOD_CREATED_ON
```
public static final String MOD_CREATED_ON
```
    See Also:
    
    Constant Field Values
  - MOD_MODIFIED_BY
```
public static final String MOD_MODIFIED_BY
```
    See Also:
    
    Constant Field Values
  - MOD_MODIFIED_ON
```
public static final String MOD_MODIFIED_ON
```
    See Also:
    
    Constant Field Values
  - NAMING_CHAR_WHITELIST
```
public static final Pattern NAMING_CHAR_WHITELIST
```
  - COOKIE_WHITELIST
```
public static final Pattern COOKIE_WHITELIST
```
  - IGC_REST_COMMON_MODEL_PKG
```
public static final String IGC_REST_COMMON_MODEL_PKG
```
    See Also:
    
    Constant Field Values
  - IGC_REST_BASE_MODEL_PKG
```
public static final String IGC_REST_BASE_MODEL_PKG
```
    See Also:
    
    Constant Field Values
  - NOTE
```
public static final String NOTE
```
    See Also:
    
    Constant Field Values
  - MAIN_OBJECT
```
public static final String MAIN_OBJECT
```
    See Also:
    
    Constant Field Values
  - INFORMATION_ASSET
```
public static final String INFORMATION_ASSET
```
    See Also:
    
    Constant Field Values
  - CLASSIFICATIONENABLEDGROUP
```
public static final String CLASSIFICATIONENABLEDGROUP
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getValidCookieNames
```
public static Set<String> getValidCookieNames()
```
    Retrieve the set of valid cookie names for the IGC REST API.
    
    Returns:
    
    Set<String>
  - getDatastageSpecificTypes
```
public static Set<String> getDatastageSpecificTypes()
```
    Retrieve the set of DataStage-specific asset types.
    
    Returns:
    
    Set<String>
  - getTypesThatCannotBeSearched
```
public static Set<String> getTypesThatCannotBeSearched()
```
    Retrieve the set of IGC object types that cannot be searched for via the IGC REST API.
    
    Returns:
    
    Set<String>
  - getModificationProperties
```
public static List<String> getModificationProperties()
```
    Retrieve a list of the modification detail properties used by the IGC REST API.
    
    Returns:
    
    List<String>
  - getFileTypes
```
public static List<String> getFileTypes()
```
    Retrieve a list of the asset types that deal with files in some way.
    
    Returns:
    
    List<String>
  - getUserTypes
```
public static List<String> getUserTypes()
```
    Retrieve a list of the asset types that deal with users in some way.
    
    Returns:
    
    List<String>
  - getImamTypeToIgcType
```
public static Map<String,String> getImamTypeToIgcType()
```
    Retrieve a mapping from IMAM type name to IGC type name.
    
    Returns:
    
    Map<String, String> where the key is the IMAM type name and value is IGC type name
  - getRelationshipLevelTypes
```
public static Set<String> getRelationshipLevelTypes()
```
    Retrieve a set of IGC asset types that are actual relationship-level assets (very rare).
    
    Returns:
    
    Set<String>
  - getPropertiesToIgnore
```
public static Set<String> getPropertiesToIgnore()
```
    Retrieve the set of properties that should be ignored for all assets.
    
    Returns:
    
    Set<String>
  - getSuperTypes
```
public static List<String> getSuperTypes()
```
    Retrieve the list of IGC object super types, in order from the highest level of abstraction to lower levels of granularity.
    
    Returns:
    
    List<String>
  - getSubTypeToSuperType
```
public static Map<String,String> getSubTypeToSuperType()
```
    Retrieve the mapping of IGC object sub-types to granular super-types.
    
    Returns:
    
    Map<String, String>
  - getFixedMainObjectProperties
```
public static Set<String> getFixedMainObjectProperties()
```
    Retrieve the list of properties that should be fixed at the Main Object level.
    
    Returns:
    
    Set<String>
  - getFixedInformationAssetProperties
```
public static Set<String> getFixedInformationAssetProperties()
```
    Retrieve the list of properties that should be fixed at the Information Asset object level.
    
    Returns:
    
    Set<String>
  - getJavaTypeForProperty
```
public static String getJavaTypeForProperty(TypeProperty property)
```
    Retrieve the name of the Java type for the provided IGC type.
    
    Parameters:
    
    property - the IGC property for which to get the type
    
    Returns:
    
    String
  - getClassNameForAssetType
```
public static String getClassNameForAssetType(String igcAssetType)
```
    Retrieve the name of a POJO class from the IGC asset type name.
    
    Parameters:
    
    igcAssetType - the name of the IGC asset type for which to retrieve a POJO classname
    
    Returns:
    
    String
  - getCamelCase
```
public static String getCamelCase(String input)
```
    Converts an IGC type or property (something_like_this) into a camelcase class name (SomethingLikeThis).
    
    Parameters:
    
    input - the IGC type or property to convert into camelcase
    
    Returns:
    
    String
  - getLowerCamelCase
```
public static String getLowerCamelCase(String input)
```
    Converts an IGC type or property (something_like_this) into lower a camelcase name (somethingLikeThis).
    
    Parameters:
    
    input - the IGC type or property to convert into lower camelcase
    
    Returns:
    
    String
  - getAssetTypeForSearch
```
public static String getAssetTypeForSearch(String assetType)
```
    Translates the type of asset into what should be used for searching. This is necessary for certain types that are actually pseudo-aliases for other types, to ensure all properties of that asset can be retrieved.
    
    Parameters:
    
    assetType - the asset type for which to retrieve the search type
    
    Returns:
    
    String
  - getConditionToForceNoSearchResults
```
public static IGCSearchCondition getConditionToForceNoSearchResults()
```
    Retrieve a search condition that will ensure no results are returned from a search.
    
    Returns:
    
    IGCSearchCondition
  - getGetterNameForProperty
```
public static String getGetterNameForProperty(String propertyName)
```
    Retrieve the getter name for the specified property.
    
    Parameters:
    
    propertyName - the IGC property
    
    Returns:
    
    String
  - getSetterNameForProperty
```
public static String getSetterNameForProperty(String propertyName)
```
    Retrieve the setter name for the specified property.
    
    Parameters:
    
    propertyName - the IGC property
    
    Returns:
    
    String

Class IGCRestConstants

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NON_IGC_PREFIX

MOD_CREATED_BY

MOD_CREATED_ON

MOD_MODIFIED_BY

MOD_MODIFIED_ON

NAMING_CHAR_WHITELIST

COOKIE_WHITELIST

IGC_REST_COMMON_MODEL_PKG

IGC_REST_BASE_MODEL_PKG

NOTE

MAIN_OBJECT

INFORMATION_ASSET

CLASSIFICATIONENABLEDGROUP

Method Detail

getValidCookieNames

getDatastageSpecificTypes

getTypesThatCannotBeSearched

getModificationProperties

getFileTypes

getUserTypes

getImamTypeToIgcType

getRelationshipLevelTypes

getPropertiesToIgnore

getSuperTypes

getSubTypeToSuperType

getFixedMainObjectProperties

getFixedInformationAssetProperties

getJavaTypeForProperty

getClassNameForAssetType

getCamelCase

getLowerCamelCase

getAssetTypeForSearch

getConditionToForceNoSearchResults

getGetterNameForProperty

getSetterNameForProperty