public class BusinessGlossaryUtil
extends BaseUtil
RequestStatus return type methods will result in being returned as either true or false as its status.
Constructor and Description |
---|
BusinessGlossaryUtil(java.lang.String token) |
BusinessGlossaryUtil(java.lang.String tokenType,
java.lang.String token) |
Modifier and Type | Method and Description |
---|---|
RequestStatus |
createAssetType(AssetType assetType)
Creates the AssetType for the given assetType object.
|
java.lang.String |
createAssetTypeAs(java.lang.String assetType,
java.lang.String outputFormat)
Creates the AssetType for the given assetType object in the form of JSON.
|
RequestStatus |
createCatalog(Catalog catalog)
Creates the Catalog for the given catalog Object.
|
java.lang.String |
createCatalogAs(java.lang.String catalog,
java.lang.String outputFormat)
Creates the Catalog for the given catalog Object i.e in the form of JSON.
|
RequestStatus |
deleteAssetType(int assetTypeId)
Deletes the assetType for the specified id.Specifying the id is mandatory
to delete a particular assetType.
|
java.lang.String |
deleteAssetTypeAs(int assetTypeId,
java.lang.String outputFormat)
Deletes the assetType with the specified assetTypeId.
|
RequestStatus |
deleteCatalog(int catalogId)
Deletes the catalog with the specified catalogId.Specifying the catalogId
is mandatory to delete a particular catalog.
|
java.lang.String |
deleteCatalogAs(int catalogId,
java.lang.String outputFormat)
Deletes the catalog with the specified catalogId.
|
AssetType |
getAssetType(int assetTypeId)
Returns the AssetType object for the specified id.
|
AssetType |
getAssetType(java.lang.String name)
Returns the AssetType object for the specified name.
|
java.lang.String |
getAssetTypeAs(int assetTypeId,
java.lang.String outputFormat)
Returns the AssetType object in the form of JSON for the specified
assetTypeId.
|
java.lang.String |
getAssetTypeByNameAs(java.lang.String name,
java.lang.String outputFormat)
Returns the AssetType object in the form of JSON for the specified
assetName.
|
java.util.List<AssetType> |
getAssetTypes(java.util.List<java.lang.Integer> assetTypeIds)
Returns the List
|
java.lang.String |
getAssetTypesAs(java.lang.String assetTypeIds,
java.lang.String outputFormat)
Returns the List of AsstetType Objects in the form of JSON for the given
assetIds.
|
java.util.List<AssetType> |
getAssetTypesByNames(java.util.List<java.lang.String> assetNames)
Returns the List
|
java.lang.String |
getAssetTypesByNamesAs(java.lang.String assetTypeNames,
java.lang.String outputFormat)
Returns the List of AsstetType Objects in the form of JSON for the given
assetTypeNames.
|
Catalog |
getCatalog(int catalogId)
Returns the Catalog object for the specified catalogId.
|
Catalog |
getCatalog(int objectTypeId,
int parentCatalogId,
java.lang.String name)
Returns the Catalog object for the specified catalogName and
parentCatalogId.
|
java.lang.String |
getCatalogAs(int catalogId,
java.lang.String outputFormat)
Returns the Catalog object in the form of JSON for the specified
catalogId.
|
java.lang.String |
getCatalogAs(java.lang.String objectType,
int parentCatalogId,
java.lang.String name,
java.lang.String outputFormat)
Returns the Catalog object in the form of JSON for the specified
catalogName and parentcatalogId.Specifying the name and parentcatalogId
are mandatory.
|
int |
getCatalogId(int objectTypeId,
java.lang.String catalogPath)
Returns the CatalogId for the specified objectTypeId and catalogPath.
|
java.lang.String |
getCatalogIdAs(java.lang.String objectType,
java.lang.String catalogPath,
java.lang.String outputFormat)
Returns the CatalogId for the specified objectType and catalogPath.
|
java.lang.String |
getCatalogPath(int objectTypeId,
int catalogId)
Returns the Catalog Path for the specified objectTypeId and
catalogId.
|
java.lang.String |
getCatalogPathAs(java.lang.String objectType,
int catalogId,
java.lang.String outputFormat)
Returns the Catalog Path for the specified objectType and
catalogId.
|
java.util.List<Catalog> |
getCatalogs(int parentCatalogId)
Returns the List
|
java.util.List<Catalog> |
getCatalogs(java.util.List<java.lang.Integer> catalogIds)
Returns the List
|
java.lang.String |
getCatalogsAs(int parentCatalogId,
java.lang.String outputFormat)
Returns the list of Catalog objects in the form of JSON for the specified
parentcatalogId.
|
java.lang.String |
getCatalogsAs(java.lang.String catalogIds,
java.lang.String outputFormat)
Returns the List of Catalog Objects in the form of JSON for the given
catalogIds.
|
RequestStatus |
importCatalog(int objectTypeId,
int catalogId,
CatalogImportHelper catalogImportHelper)
Imports the Catalog on the specified catalogId and objectTypeId.
|
RequestStatus |
importCatalog(int objectTypeId,
java.lang.String catalogPath,
java.lang.String catalogName,
CatalogImportHelper catalogImportHelper)
Imports the Catalog at the root level for the specified
objectTypeId.
|
java.lang.String |
importCatalogAs(java.lang.String objectType,
int catalogId,
java.lang.String catalogImportHelper,
java.lang.String outputFormat)
Imports the Catalog on the specified catalogId and objectType.
|
java.lang.String |
importCatalogAs(java.lang.String objectType,
java.lang.String catalogPath,
java.lang.String catalogName,
java.lang.String catalogImportHelper,
java.lang.String outputFormat)
Imports the Catalog at the root level for the specified
objectType.
|
RequestStatus |
publishBusinessPolicies(java.util.List<java.lang.Integer> businessPolicyIds) |
java.lang.String |
publishBusinessPoliciesAs(java.lang.String businessPolicyIdsJsonArray,
java.lang.String outputFormat) |
RequestStatus |
publishBusinessPolicy(int businessPolicyId) |
java.lang.String |
publishBusinessPolicyAs(int businessPolicyId,
java.lang.String outputFormat) |
RequestStatus |
publishBusinessRule(int businessRuleId) |
java.lang.String |
publishBusinessRuleAs(int businessRuleId,
java.lang.String outputFormat) |
RequestStatus |
publishBusinessRules(java.util.List<java.lang.Integer> businessRuleIds) |
java.lang.String |
publishBusinessRulesAs(java.lang.String businessRuleIdsJsonArray,
java.lang.String outputFormat) |
RequestStatus |
publishCustomObject(int customObjectId) |
java.lang.String |
publishCustomObjectAs(int customObjectId,
java.lang.String outputFormat) |
RequestStatus |
publishCustomObjects(java.util.List<java.lang.Integer> customObjectIds) |
java.lang.String |
publishCustomObjectsAs(java.lang.String customObjectIdsJsonArray,
java.lang.String outputFormat) |
RequestStatus |
publishTerm(int businessTermId) |
java.lang.String |
publishTermAs(int businessTermId,
java.lang.String outputFormat) |
RequestStatus |
publishTerms(java.util.List<java.lang.Integer> businessTermIds) |
java.lang.String |
publishTermsAs(java.lang.String businessTermIdsJsonArray,
java.lang.String outputFormat) |
RequestStatus |
updateAssetType(AssetType assetType)
Updates the AssetType with the specified assetType Object.All the
information pertaining to the assetType can be updated.
|
java.lang.String |
updateAssetTypeAs(java.lang.String assetType,
java.lang.String outputFormat)
Updates the AssetType with the specified assetType Object in the form of
JSON.
|
RequestStatus |
updateCatalog(Catalog catalog)
Updates the catalog with the specified catalog object.
|
java.lang.String |
updateCatalogAs(java.lang.String catalog,
java.lang.String outputFormat)
Updates the catalog with the specified catalog object i.e in the form of
JSON.
|
public BusinessGlossaryUtil(java.lang.String token)
public BusinessGlossaryUtil(java.lang.String tokenType, java.lang.String token)
public RequestStatus publishTerm(int businessTermId)
businessTermId
- public RequestStatus publishTerms(java.util.List<java.lang.Integer> businessTermIds)
businessTermIds
- public java.lang.String publishTermAs(int businessTermId, java.lang.String outputFormat)
businessTermId
- outputFormat
- public java.lang.String publishTermsAs(java.lang.String businessTermIdsJsonArray, java.lang.String outputFormat)
businessTermIdsJsonArray
- outputFormat
- public RequestStatus publishBusinessPolicy(int businessPolicyId)
businessPolicyId
- public RequestStatus publishBusinessPolicies(java.util.List<java.lang.Integer> businessPolicyIds)
businessPolicyIds
- public RequestStatus publishBusinessRule(int businessRuleId)
businessRuleId
- public RequestStatus publishBusinessRules(java.util.List<java.lang.Integer> businessRuleIds)
businessRuleIds
- public RequestStatus publishCustomObject(int customObjectId)
customObjectId
- public RequestStatus publishCustomObjects(java.util.List<java.lang.Integer> customObjectIds)
customObjectIds
- public java.lang.String publishBusinessPolicyAs(int businessPolicyId, java.lang.String outputFormat)
businessPolicyId
- outputFormat
- public java.lang.String publishBusinessPoliciesAs(java.lang.String businessPolicyIdsJsonArray, java.lang.String outputFormat)
businessPolicyIdsJsonArray
- outputFormat
- public java.lang.String publishBusinessRuleAs(int businessRuleId, java.lang.String outputFormat)
businessRuleId
- outputFormat
- public java.lang.String publishBusinessRulesAs(java.lang.String businessRuleIdsJsonArray, java.lang.String outputFormat)
businessRuleIdsJsonArray
- outputFormat
- public java.lang.String publishCustomObjectAs(int customObjectId, java.lang.String outputFormat)
customObjectId
- outputFormat
- public java.lang.String publishCustomObjectsAs(java.lang.String customObjectIdsJsonArray, java.lang.String outputFormat)
customObjectIdsJsonArray
- outputFormat
- public RequestStatus createAssetType(AssetType assetType)
assetType
- AssetTypepublic RequestStatus updateAssetType(AssetType assetType)
assetType
- AssetType Objectpublic RequestStatus deleteAssetType(int assetTypeId)
assetTypeId
- intpublic AssetType getAssetType(int assetTypeId) throws DAOException
assetTypeId
- intDAOException
public AssetType getAssetType(java.lang.String name) throws DAOException
name
- StringDAOException
public java.util.List<AssetType> getAssetTypes(java.util.List<java.lang.Integer> assetTypeIds) throws DAOException
assetTypeIds
- listDAOException
public java.util.List<AssetType> getAssetTypesByNames(java.util.List<java.lang.String> assetNames) throws DAOException
assetNames
- listcom.ads.api.exceptions.DAOException
DAOException
public RequestStatus createCatalog(Catalog catalog)
catalog
- Catalogpublic RequestStatus updateCatalog(Catalog catalog)
catalog
- Catalog Objectpublic RequestStatus deleteCatalog(int catalogId)
catalogId
- intpublic Catalog getCatalog(int catalogId) throws DAOException
catalogId
- intDAOException
public Catalog getCatalog(int objectTypeId, int parentCatalogId, java.lang.String name) throws java.lang.Exception
objectTypeId
- intname
- StringparentCatalogId
- intjava.lang.Exception
public int getCatalogId(int objectTypeId, java.lang.String catalogPath) throws DAOException
objectTypeId
- intcatalogPath
- String - ex: Catalog1/Catalog2/Catalog3DAOException
public java.util.List<Catalog> getCatalogs(java.util.List<java.lang.Integer> catalogIds) throws java.lang.Exception
catalogIds
- listjava.lang.Exception
public java.util.List<Catalog> getCatalogs(int parentCatalogId) throws java.lang.Exception
parentCatalogId
- intjava.lang.Exception
public RequestStatus importCatalog(int objectTypeId, int catalogId, CatalogImportHelper catalogImportHelper)
objectTypeId
- - intcatalogId
- - intcatalogImportHelper
- - catalogImportHelper objectpublic RequestStatus importCatalog(int objectTypeId, java.lang.String catalogPath, java.lang.String catalogName, CatalogImportHelper catalogImportHelper)
objectTypeId
- - intcatalogPath
- - String - ex: Catalog1/Catalog2/Catalog3catalogName
- - StringcatalogImportHelper
- - catalogImportHelper objectpublic java.lang.String getCatalogPath(int objectTypeId, int catalogId) throws DAOException
objectTypeId
- intcatalogId
- intDAOException
public java.lang.String createCatalogAs(java.lang.String catalog, java.lang.String outputFormat)
catalog
- StringoutputFormat
- String
Sample 'catalog' JSON :
{
"parentCatalogId": "",
"catalogName": "",
"description": "",
"catalogTypeId": ""
}
public java.lang.String updateCatalogAs(java.lang.String catalog, java.lang.String outputFormat)
catalog
- StringoutputFormat
- String
Sample 'catalog' JSON :
{
"catalogId": "",
"parentCatalogId": "",
"catalogName": "",
"description": "",
"catalogTypeId": ""
}
public java.lang.String deleteCatalogAs(int catalogId, java.lang.String outputFormat)
catalogId
- intoutputFormat
- Stringpublic java.lang.String getCatalogAs(int catalogId, java.lang.String outputFormat)
catalogId
- intoutputFormat
- Stringpublic java.lang.String getCatalogAs(java.lang.String objectType, int parentCatalogId, java.lang.String name, java.lang.String outputFormat)
objectType
- String - Valid values: BGM_TERM,BGM_POLICY,BGM_RULE and
for Custom types it will be the name of asset type.name
- StringparentCatalogId
- intoutputFormat
- Stringpublic java.lang.String getCatalogIdAs(java.lang.String objectType, java.lang.String catalogPath, java.lang.String outputFormat)
objectType
- - String - Valid values: BGM_TERM,BGM_POLICY,BGM_RULE and
for Custom types it will be the name of asset type.catalogPath
- String - ex: Catalog1/Catalog2/Catalog3outputFormat
- Stringpublic java.lang.String getCatalogsAs(java.lang.String catalogIds, java.lang.String outputFormat)
catalogIds
- String in the form of json arrayoutputFormat
- String
Sample 'catalogIds' JSONArray :
[1,2]
public java.lang.String getCatalogsAs(int parentCatalogId, java.lang.String outputFormat)
parentCatalogId
- intoutputFormat
- Stringpublic java.lang.String getCatalogPathAs(java.lang.String objectType, int catalogId, java.lang.String outputFormat)
objectType
- - String - Valid values: BGM_TERM,BGM_POLICY,BGM_RULE and
for Custom types it will be the name of asset type.catalogId
- intoutputFormat
- Stringpublic java.lang.String importCatalogAs(java.lang.String objectType, int catalogId, java.lang.String catalogImportHelper, java.lang.String outputFormat)
objectType
- - String - Valid values: BGM_TERM,BGM_POLICY,BGM_RULE and
for Custom types it will be the name of asset type.catalogId
- - intcatalogImportHelper
- - StringoutputFormat
- Stringpublic java.lang.String importCatalogAs(java.lang.String objectType, java.lang.String catalogPath, java.lang.String catalogName, java.lang.String catalogImportHelper, java.lang.String outputFormat)
objectType
- - String - Valid values: BGM_TERM,BGM_POLICY,BGM_RULE and
for Custom types it will be the name of asset type.catalogPath
- - StringcatalogName
- - StringcatalogImportHelper
- - StringoutputFormat
- Stringpublic java.lang.String createAssetTypeAs(java.lang.String assetType, java.lang.String outputFormat)
assetType
- StringoutputFormat
- String
Sample 'assetType' JSON :
{
"objectTypeId": "",
"catalogTypeId": "",
"catalogsTypeId": "",
"name": "",
"title": "",
"description": "",
"color": "",
"documentsRequried": "",
"enabled": "true",
"definitionEnabled": "",
"sdiEnabled": "",
"systemBased": "",
"displayOrder": "",
"auditHistory": null
}
public java.lang.String updateAssetTypeAs(java.lang.String assetType, java.lang.String outputFormat)
assetType
- StringoutputFormat
- Stringpublic java.lang.String deleteAssetTypeAs(int assetTypeId, java.lang.String outputFormat)
assetTypeId
- intoutputFormat
- Stringpublic java.lang.String getAssetTypeAs(int assetTypeId, java.lang.String outputFormat)
assetTypeId
- intoutputFormat
- Stringpublic java.lang.String getAssetTypeByNameAs(java.lang.String name, java.lang.String outputFormat)
name
- StringoutputFormat
- Stringpublic java.lang.String getAssetTypesAs(java.lang.String assetTypeIds, java.lang.String outputFormat)
assetTypeIds
- String in the form of json arrayoutputFormat
- String
Sample 'assetIds' JSONArray :
[1,2]
public java.lang.String getAssetTypesByNamesAs(java.lang.String assetTypeNames, java.lang.String outputFormat)
assetTypeNames
- String in the form of json arrayoutputFormat
- String
Sample 'assetTypeNames' JSONArray :
["Custom_A","Custom_B"]