oracle.ifs.fdk
Interface CategoryManager

public interface CategoryManager

The Category management Facade interface

Method Summary

Item	addMetaDataAttribute(long mdscatId, NamedValue attributedef, AttributeRequest[] attrrequest) Given an Attribute description, add the attribute to the given class and return the new Attribute item
Item	createCategorySubClass(NamedValue[] attributes, AttributeRequest[] attrrequest) Given an array of Attributes that describes a class object, create the Category class object and return the classobject id.
void	deleteCategory(long item) Delete a Category instance
void	freeCategoryClass(long ahcclassId) Frees the given class object.
Item[]	getRequiredCategories(long folderId, AttributeRequest[] requestedAttributes) Gets the required categories for a folder.
Item	modifyCategorySubClass(long mdscatId, NamedValue[] attributes, AttributeRequest[] attrrequest) modifies the given Category subclass.
Item	modifyMetaDataAttribute(long attributeId, NamedValue attributedef, AttributeRequest[] attrrequest) Given an Attribute description, modify the attribute to the given class and return the modified classobject id.
void	removeCategoryAttribute(long mdscatId, java.lang.String attributename) Remove an attribute from a MetaDataCategory class.
void	removeCategoryConfiguration(long folderId) remove the existing CategoryConfiguration for a Folder
void	removeMetaDataAttribute(long attributeId) Remove an attribute from a MetaDataCategory class.
void	setCategoryConfiguration(long folderId, NamedValue[] config) Sets or updates the CategoryConfiguration for a Folder.
Item	updateCategory(long catId, NamedValue[] attrs, AttributeRequest[] attributes) Updates an existing Category

Method Detail

addMetaDataAttribute

public Item addMetaDataAttribute(long mdscatId,
                                 NamedValue attributedef,
                                 AttributeRequest[] attrrequest)
                          throws FdkException

Given an Attribute description, add the attribute to the given class and return the new Attribute item

Parameters:

attributedef - array of NamedValue for adding a new attribute

• {Attributes.ATTRIBUTE_DETAIL, NamedValue[]}
  • {Attributes.ATTRIBUTE_NAME, String}
  • {Attributes.ATTRIBUTE_DISPLAY_NAME, String}
  • {Attributes.ATTRIBUTE_REQUIRED, Boolean}
  • {Attributes.ATTRIBUTE_SETTABLE, Boolean}
  • {Attributes.ATTRIBUTE_UPDATEABLE, Boolean}
  • {Attributes.ATTRIBUTE_PROMPT, Boolean}
  • {Attributes.ATTRIBUTE_OVERRIDEABLE, Boolean}
  • {Attributes.ATTRIBUTE_TYPE, String}
  • Where value of ATTRIBUTE_TYPE is
    • FdkConstants.ATTRIBUTE_TYPE_STRING
    • FdkConstants.ATTRIBUTE_TYPE_STRING_ARRAY
    • FdkConstants.ATTRIBUTE_TYPE_DATE
    • FdkConstants.ATTRIBUTE_TYPE_INTEGER
    • FdkConstants.ATTRIBUTE_TYPE_BOOLEAN
    • FdkConstants.ATTRIBUTE_TYPE_FLOAT
    • FdkConstants.ATTRIBUTE_TYPE_USER
    • FdkConstants.ATTRIBUTE_TYPE_GROUP
  • {Attributes.ATTRIBUTE_DEFAULT, type}
  • {Attributes.ATTRIBUTE_ENUMERATION, [] type}

  attrrequest - requested attributes for each item, or null.

  Returns:

  id of the newly created attribute

  Throws:

  FdkException - if the operation fails

  (Published)

createCategorySubClass

public Item createCategorySubClass(NamedValue[] attributes,
                                   AttributeRequest[] attrrequest)
                            throws FdkException

Given an array of Attributes that describes a class object, create the Category class object and return the classobject id. If Workflow is enabled AND 'CreateUserCategory' is workflow enabled, then an item of type 'REQUEST' is returned. Otherwise, the function returns the created category. UI implementers should check the type of the Item returned and act accordingly (If it's a request, inform user the request needs to be approved before the category can be created.).

Parameters:

attributes - array of attributes for creating the category class

• notation: {Attribute name, Attribute type}
• {Attributes.CLASS_NAME, String}
• {Attributes.DESCRIPTION, String}
• {Attributes.CLASS_DISPLAY_NAME, String}
• {Attributes.SUPERCLASS, long}
• {Attributes.CLASS_ABSTRACT, Boolean}
• {Attributes.CLASS_FINAL, Boolean}
• {Attributes.CLASS_HIDDEN, Boolean}
• {Attributes.CLASS_COPIED, Boolean}
• {Attributes.ATTRIBUTE_DETAILS, NamedValue[]}
  • {Attributes.ATTRIBUTE_DETAIL, NamedValue[]}
    • {Attributes.ATTRIBUTE_NAME, String}
    • {Attributes.ATTRIBUTE_DISPLAY_NAME, String}
    • {Attributes.ATTRIBUTE_REQUIRED, Boolean}
    • {Attributes.ATTRIBUTE_SETTABLE, Boolean}
    • {Attributes.ATTRIBUTE_UPDATEABLE, Boolean}
    • {Attributes.ATTRIBUTE_HIDDEN, Boolean}
    • {Attributes.ATTRIBUTE_OVERRIDEABLE, Boolean}
    • {Attributes.ATTRIBUTE_TYPE, String}
    • Where value of ATTRIBUTE_TYPE is
      • FdkConstants.ATTRIBUTE_TYPE_STRING
      • FdkConstants.ATTRIBUTE_TYPE_STRING_ARRAY
      • FdkConstants.ATTRIBUTE_TYPE_DATE
      • FdkConstants.ATTRIBUTE_TYPE_INTEGER
      • FdkConstants.ATTRIBUTE_TYPE_BOOLEAN
      • FdkConstants.ATTRIBUTE_TYPE_FLOAT
      • FdkConstants.ATTRIBUTE_TYPE_USER
      • FdkConstants.ATTRIBUTE_TYPE_GROUP
    • {Attributes.ATTRIBUTE_DEFAULT, type}
    • {Attributes.ATTRIBUTE_ENUMERATION, [] type}
• {Attributes.REQUEST_JUSTIFICATION, String}

attrrequest - requested attributes for each item, or null.

Returns:

id of the newly created subclass

Throws:

FdkException - if the operation fails

(Published)

deleteCategory

public void deleteCategory(long item)
                    throws FdkException

Delete a Category instance

Throws:

FdkException - if the operation fails.

freeCategoryClass

public void freeCategoryClass(long ahcclassId)
                       throws FdkException

Frees the given class object. Only succeeds if no instances or subclasses exists.

Throws:

FdkException

(Published)

getRequiredCategories

public Item[] getRequiredCategories(long folderId,
                                    AttributeRequest[] requestedAttributes)
                             throws FdkException

Gets the required categories for a folder.

Parameters:

folderId - folder for to fetch the categories

requestedAttributes - list of attributes needed for each item

Returns:

required categories for this folder; null if no category is marked as required.

Throws:

FdkException - if the operation fails

(Published)

modifyCategorySubClass

public Item modifyCategorySubClass(long mdscatId,
                                   NamedValue[] attributes,
                                   AttributeRequest[] attrrequest)
                            throws FdkException

modifies the given Category subclass. Only display name and description may be changed.

Parameters:

attributes - array of attributes for creating the category class

• notation: {Attribute name, Attribute type}
• {Attributes.CLASS_DISPLAY_NAME, String}
• {Attributes.DESCRIPTION, String}

  Throws:

  FdkException

  (Published)

modifyMetaDataAttribute

public Item modifyMetaDataAttribute(long attributeId,
                                    NamedValue attributedef,
                                    AttributeRequest[] attrrequest)
                             throws FdkException

Given an Attribute description, modify the attribute to the given class and return the modified classobject id.

Parameters:

attributeId - id of attribute to be modified.

attributedef - array of NamedValue for adding a new attribute

• {Attributes.ATTRIBUTE_DETAIL, NamedValue[]}
  • {Attributes.ATTRIBUTE_DISPLAY_NAME, String}
  • {Attributes.ATTRIBUTE_SETTABLE, Boolean}
  • {Attributes.ATTRIBUTE_UPDATEABLE, Boolean}
  • {Attributes.ATTRIBUTE_REQUIRED, Boolean}
  • {Attributes.ATTRIBUTE_PROMPT, Boolean}
  • {Attributes.ATTRIBUTE_HIDDEN, Boolean}
  • {Attributes.ATTRIBUTE_OVERRIDEABLE, Boolean}
  • {Attributes.ATTRIBUTE_DEFAULT, type}
  • {Attributes.ATTRIBUTE_ENUMERATION, [] type}

  attrrequest - requested attributes for each item, or null.

  Returns:

  newly modified METADATA_ATTRIBUTE

  Throws:

  FdkException - if the operation fails

  (Published)

removeCategoryAttribute

public void removeCategoryAttribute(long mdscatId,
                                    java.lang.String attributename)
                             throws FdkException

Remove an attribute from a MetaDataCategory class. This operation cannot be undone.

Parameters:

attributename - name of attribute to remove.

Throws:

FdkException - deprecated use removeMetaDataAttibute

(Published)

removeCategoryConfiguration

public void removeCategoryConfiguration(long folderId)
                                 throws FdkException

remove the existing CategoryConfiguration for a Folder

Parameters:

folderId - the folder for which to remove the Category configuration

Throws:

FdkException - if the operation fails.

removeMetaDataAttribute

public void removeMetaDataAttribute(long attributeId)
                             throws FdkException

Remove an attribute from a MetaDataCategory class. This operation cannot be undone.

Parameters:

attributeId - id of MetaDataAttribute to remove.

Throws:

FdkException

(Published)

setCategoryConfiguration

public void setCategoryConfiguration(long folderId,
                                     NamedValue[] config)
                              throws FdkException

Sets or updates the CategoryConfiguration for a Folder. AttributeOverrides are replaced as a set. To change one, you must specify all overrides. To remove all overrides, explicitely set ATTRIBUTE_OVERRIDE to null.

Parameters:

folderId - the folder for which to set the Category configuration

config - the Category configuration options to set; must include one or more of the following Attributes:

• notation: {Attribute name, Attribute type}
• {Attributes.ALLOW_ALL_CATEGORIES, Boolean}
• {Attributes.ALLOWED_CATEGORIES, long[]} each element is an Category Class.
• {Attributes.REQUIRED_CATEGORIES, long[]} each element is an Category Class.}
• {Attributes.CONFIGURATION_FINAL, Boolean}
• {Attributes.CONFIGURATION_ENABLED, Boolean}
• {Attributes.ATTRIBUTE_OVERRIDE, NamedValue [][]} can be specificied multiple times, one for each attribute.
  • each row is an array that describes an attribute override
    • {Attributes.ATTRIBUTE_OVERRIDE_CATEGORY_CLASS, id}
    • {Attributes.ATTRIBUTE_OVERRIDE_ATTRIBUTE, id}
    • {Attributes.ATTRIBUTE_OVERRIDE_DEFAULT, Object}
    • {Attributes.ATTRIBUTE_OVERRIDE_PROMPT, Boolean}
    • {Attributes.ATTRIBUTE_OVERRIDE_REQUIRED, Boolean}
    • {Attributes.ATTRIBUTE_OVERRIDE_SETTABLE, Boolean}

Throws:

FdkException - if the operation fails.

updateCategory

public Item updateCategory(long catId,
                           NamedValue[] attrs,
                           AttributeRequest[] attributes)
                    throws FdkException

Updates an existing Category

Parameters:

catId - Category to be updated

attributes - requested attributes for each item, or null.

Returns:

the updated Category.

Throws:

FdkException

(Published)