oracle.ifs.fdk

Interface RelationManager

All Superinterfaces:

Remote

All Known Implementing Classes:

CoreRelationManager, RelationManagerImpl

public interface RelationManager
extends Remote

Method Summary

Modifier and Type	Method and Description
Item	createRelation(long from, long to, NamedValue[] options, AttributeRequest[] attributes) Create a new relation between two documents.
void	deleteRelation(long id) Delete a relation.
String[]	listRelationActionSpecifications() Returns the list of registered relation action specifications.
Item	updateRelation(long id, NamedValue[] options, AttributeRequest[] attributes) Update an existing relation.

Method Detail

listRelationActionSpecifications

String[] listRelationActionSpecifications()
                                   throws FdkException

Returns the list of registered relation action specifications.

Any element of the return value may be used as the value for the RELATION_ACTION attribute of a RELATION Item.

Throws:

FdkException - if the operation fails

createRelation

Item createRelation(long from,
                    long to,
                    NamedValue[] options,
                    AttributeRequest[] attributes)
             throws FdkException

Create a new relation between two documents.

Parameters:

from - The from/source/left side of the relation. Must be of type DOCUMENT.

to - To to/destination/right side of the relation. Must be of type DOCUMENT. A value <= 0 implies a null object.

options - The options of the relation. Supported options:

• notation: {Attribute name, Attribute type}
• {Attributes.NAME, String}
• {Attributes.DESCRIPTION, String}
• {Attributes.RELATION_TYPE, String}
• {Attributes.RELATION_ACTION, String}
• {Options.CATEGORY_DEFINITION, NamedValue[]}

attributes - Attributes to return for the return item.

Returns:

The newly creates relation as an Item of type RELATION.

Throws:

FdkException - if the operation fails.

updateRelation

Item updateRelation(long id,
                    NamedValue[] options,
                    AttributeRequest[] attributes)
             throws FdkException

Update an existing relation.

Parameters:

id - The ID of an existing relation. Must be of type RELATION.

options - The options of the relation. Supported options:

• notation: {Attribute name, Attribute type}
• {Attributes.NAME, String}
• {Attributes.DESCRIPTION, String}
• {Attributes.RELATION_TO, Long} to/destination/right side of the relation
• {Attributes.RELATION_TYPE, String}
• {Attributes.RELATION_ACTION, String}
• {Options.CATEGORY_DEFINITION, NamedValue[]}
• {Options.REMOVE_CATEGORY_ID, Long}

attributes - Attributes to return for the return item.

Returns:

The updated relation as an Item of type RELATION.

Throws:

FdkException - if the operation fails.

deleteRelation

void deleteRelation(long id)
             throws FdkException

Delete a relation.

Parameters:

id - The ID of the relation to delete.

Throws:

FdkException - if the operation fails.