Interface | osid.resource.ResourceManager | ||
---|---|---|---|
Implements | osid.OsidManager | ||
osid.resource.ResourceProfile | |||
Description |
The resource manager provides access to resource lookup and creation sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
| ||
Method | getResourceLookupSession | ||
Description |
Gets the | ||
Return | osid.resource.ResourceLookupSession | a ResourceLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsResourceLookup() is false | ||
Compliance | optional | This method must be implemented if supportsResourceLookup()
is true. | |
Method | getResourceLookupSessionForBin | ||
Description |
Gets the | ||
Parameters | osid.id.Id | binId | the Id of the bin |
Return | osid.resource.ResourceLookupSession | a ResourceLookupSession | |
Errors | NOT_FOUND | binId not found | |
NULL_ARGUMENT | binId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsResourceLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsResourceLookup()
and supportsVisibleFederation() are true. | |
Method | getResourceQuerySession | ||
Description |
Gets a resource query session. | ||
Return | osid.resource.ResourceQuerySession | a ResourceQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsResourceQuery() is false | ||
Compliance | optional | This method must be implemented if supportsResourceQuery()
is true. | |
Method | getResourceQuerySessionForBin | ||
Description |
Gets a resource query session for the given bin. | ||
Parameters | osid.id.Id | binId | the Id of the bin |
Return | osid.resource.ResourceQuerySession | a ResourceQuerySession | |
Errors | NOT_FOUND | binId not found | |
NULL_ARGUMENT | binId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsResourceQuery() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsResourceQuery()
and supportsVisibleFederation() are true. | |
Method | getResourceSearchSession | ||
Description |
Gets a resource search session. | ||
Return | osid.resource.ResourceSearchSession | a ResourceSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsResourceSearch() is false | ||
Compliance | optional | This method must be implemented if supportsResourceSearch()
is true. | |
Method | getResourceSearchSessionForBin | ||
Description |
Gets a resource search session for the given bin. | ||
Parameters | osid.id.Id | binId | the Id of the bin |
Return | osid.resource.ResourceSearchSession | a ResourceSearchSession | |
Errors | NOT_FOUND | binId not found | |
NULL_ARGUMENT | binId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsResourceSearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsResourceSearch()
and supportsVisibleFederation() are true. | |
Method | getResourceAdminSession | ||
Description |
Gets a resource administration session for creating, updating and deleting resources. | ||
Return | osid.resource.ResourceAdminSession | a ResourceAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsResourceAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsResourceAdmin()
is true. | |
Method | getResourceAdminSessionForBin | ||
Description |
Gets a resource administration session for the given bin. | ||
Parameters | osid.id.Id | binId | the Id of the bin |
Return | osid.resource.ResourceAdminSession | a ResourceAdminSession | |
Errors | NOT_FOUND | binId not found | |
NULL_ARGUMENT | binId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsResourceAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsResourceAdmin()
and supportsVisibleFederation() are true. | |
Method | getResourceNotificationSession | ||
Description |
Gets the notification session for notifications pertaining to resource changes. | ||
Parameters | osid.resource.ResourceReceiver | resourceReceiver | the notification callback |
Return | osid.resource.ResourceNotificationSession | a ResourceNotificationSession | |
Errors | NULL_ARGUMENT | resourceReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsResourceNotification() is false | ||
Compliance | optional | This method must be implemented if supportsResourceNotification()
is true. | |
Method | getResourceNotificationSessionForBin | ||
Description |
Gets the resource notification session for the given bin. | ||
Parameters | osid.resource.ResourceReceiver | resourceReceiver | the notification callback |
osid.id.Id | binId | the Id of the bin | |
Return | osid.resource.ResourceNotificationSession | a ResourceNotificationSession | |
Errors | NOT_FOUND | binId not found | |
NULL_ARGUMENT | resourceReceiver or binId is null
| ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsResourceNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsResourceNotfication()
and supportsVisibleFederation() are true.
| |
Method | getResourceBinSession | ||
Description |
Gets the session for retrieving resource to bin mappings. | ||
Return | osid.resource.ResourceBinSession | a ResourceBinSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsResourceBin() is false | ||
Compliance | optional | This method must be implemented if supportsResourceBin() is
true. | |
Method | getResourceBinAssignmentSession | ||
Description |
Gets the session for assigning resource to bin mappings. | ||
Return | osid.resource.ResourceBinAssignmentSession | a ResourceBinAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsResourceBinAssignment() is false | ||
Compliance | optional | This method must be implemented if supportsResourceBinAssignment()
is true. | |
Method | getResourceSmartBinSession | ||
Description |
Gets the session for managing dynamic resource bins. | ||
Parameters | osid.id.Id | binId | the Id of the bin |
Return | osid.resource.ResourceSmartBinSession | a ResourceSmartBinSession | |
Errors | NOT_FOUND | binId not found | |
NULL_ARGUMENT | binId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsResourceSmartBin() is false | ||
Compliance | optional | This method must be implemented if supportsResourceSmartBin()
is true. | |
Method | getMembershipSession | ||
Description |
Gets the session for querying memberships. | ||
Return | osid.resource.MembershipSession | a MembershipSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsMembership() is false | ||
Compliance | optional | This method must be implemented if supportMembership() is
true. | |
Method | getMembershipSessionForBin | ||
Description |
Gets a resource membership session for the given bin. | ||
Parameters | osid.id.Id | binId | the Id of the bin |
Return | osid.resource.MembershipSession | a MembershipSession | |
Errors | NOT_FOUND | binId not found | |
NULL_ARGUMENT | binId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsMembership() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsMembership() and
supportsVisibleFederation() are true. | |
Method | getGroupSession | ||
Description |
Gets the session for retrieving gropup memberships. | ||
Return | osid.resource.GroupSession | a GroupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsGroup() is false | ||
Compliance | optional | This method must be implemented if supportsGroup() is
true. | |
Method | getGroupSessionForBin | ||
Description |
Gets a group session for the given bin. | ||
Parameters | osid.id.Id | binId | the Id of the bin |
Return | osid.resource.GroupSession | a GroupSession | |
Errors | NOT_FOUND | binId not found | |
NULL_ARGUMENT | binId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsGroup() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsGroup() and
supportsVisibleFederation() are true. | |
Method | getGroupAssignmentSession | ||
Description |
Gets the session for assigning resources to groups. | ||
Return | osid.resource.GroupAssignmentSession | a GroupAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsGroupAssignment() is false | ||
Compliance | optional | This method must be implemented if supportsGroupAssignment()
is true. | |
Method | getGroupAssignmentSessionForBin | ||
Description |
Gets a group assignment session for the given bin. | ||
Parameters | osid.id.Id | binId | the Id of the bin |
Return | osid.resource.GroupAssignmentSession | a GroupAssignmentSession | |
Errors | NOT_FOUND | binId not found | |
NULL_ARGUMENT | binId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsGroupAssignment() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsGroupAssignment()
and supportsVisibleFederation() are true. | |
Method | getGroupNotificationSession | ||
Description |
Gets the notification session for notifications pertaining to resource changes. | ||
Parameters | osid.resource.GroupReceiver | groupRceeiver | the notification callback |
Return | osid.resource.GroupNotificationSession | a GroupNotificationSession | |
Errors | NULL_ARGUMENT | groupReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsGroupNotification() is false | ||
Compliance | optional | This method must be implemented if supportsGroupNotification()
is true. | |
Method | getGroupNotificationSessionForBin | ||
Description |
Gets the group notification session for the given bin. | ||
Parameters | osid.resource.GroupReceiver | groupRceeiver | the notification callback |
osid.id.Id | binId | the Id of the bin | |
Return | osid.resource.GroupNotificationSession | a GroupNotificationSession | |
Errors | NOT_FOUND | binId not found | |
NULL_ARGUMENT | groupReceiver or binId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsGroupNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsGroupNotfication()
and supportsVisibleFederation() are true.
| |
Method | getGroupHierarchySession | ||
Description |
Gets a session for retrieving gropup hierarchies. | ||
Return | osid.resource.GroupHierarchySession | a GroupHierarchySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsGroupHierarchy() is false | ||
Compliance | optional | This method must be implemented if supportsGroupHierarchy()
is true. | |
Method | getGroupHierarchySessionForBin | ||
Description |
Gets a group hierarchy session for the given bin. | ||
Parameters | osid.id.Id | binId | the Id of the bin |
Return | osid.resource.GroupHierarchySession | a GroupHierarchySession | |
Errors | NOT_FOUND | binId not found | |
NULL_ARGUMENT | binId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsGroupHierarchy() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsGroupHierarchy()
and supportsVisibleFederation() are true. | |
Method | getResourceAgentSession | ||
Description |
Gets the session for retrieving resource agent mappings. | ||
Return | osid.resource.ResourceAgentSession | a ResourceAgentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsResourceAgent() is false | ||
Compliance | optional | This method must be implemented if supportsResourceAgent()
is true. | |
Method | getResourceAgentSessionForBin | ||
Description |
Gets a resource agent session for the given bin. | ||
Parameters | osid.id.Id | binId | the Id of the bin |
Return | osid.resource.ResourceAgentSession | a ResourceAgentSession | |
Errors | NOT_FOUND | binId not found | |
NULL_ARGUMENT | binId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsResourceAgent() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsResourceAgent()
and supportsVisibleFederation() are true. | |
Method | getResourceAgentAssignmentSession | ||
Description |
Gets the session for assigning agents to resources. | ||
Return | osid.resource.ResourceAgentAssignmentSession | a ResourceAgentAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsResourceAgentAssignment() is false | ||
Compliance | optional | This method must be implemented if supportsResourceAgentAssignment()
is true. | |
Method | getResourceAgentAssignmentSessionForBin | ||
Description |
Gets a resource agent session for the given bin. | ||
Parameters | osid.id.Id | binId | the Id of the bin |
Return | osid.resource.ResourceAgentAssignmentSession | a ResourceAgentAssignmentSession | |
Errors | NOT_FOUND | binId not found | |
NULL_ARGUMENT | binId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsResourceAgentAssignment() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsResourceAgentAssignment()
and supportsVisibleFederation() are true.
| |
Method | getResourceRelationshipLookupSession | ||
Description |
Gets the | ||
Return | osid.resource.ResourceRelationshipLookupSession | a ResourceRelationshipLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsResourceRelationshipLookup() is false | ||
Compliance | optional | This method must be implemented if
supportsResourceRelationshipLookup() is true. | |
Method | getResourceRelationshipLookupSessionForBin | ||
Description |
Gets the | ||
Parameters | osid.id.Id | binId | the Id of the Bin |
Return | osid.resource.ResourceRelationshipLookupSession | a ResourceRelationshipLookupSession | |
Errors | NOT_FOUND | no Bin found by the given Id | |
NULL_ARGUMENT | binId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsResourceRelationshipLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsResourceRelationshipLookup() and
supportsVisibleFederation() are true | |
Method | getResourceRelationshipQuerySession | ||
Description |
Gets the | ||
Return | osid.resource.ResourceRelationshipQuerySession | a ResourceRelationshipQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsResourceRelationshipQuery() is false | ||
Compliance | optional | This method must be implemented if
supportsResourceRelationshipQuery() is true. | |
Method | getResourceRelationshipQuerySessionForBin | ||
Description |
Gets the | ||
Parameters | osid.id.Id | binId | the Id of the Bin |
Return | osid.resource.ResourceRelationshipQuerySession | a ResourceRelationshipQuerySession | |
Errors | NOT_FOUND | no Bin found by the given Id | |
NULL_ARGUMENT | binId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsResourceRelationshipQuery() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsResourceRelationshipQuery() and
supportsVisibleFederation() are true | |
Method | getResourceRelationshipSearchSession | ||
Description |
Gets the | ||
Return | osid.resource.ResourceRelationshipSearchSession | a ResourceRelationshipSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsResourceRelationshipSearch() is false | ||
Compliance | optional | This method must be implemented if
supportsResourceRelationshipSearch() is true. | |
Method | getResourceRelationshipSearchSessionForBin | ||
Description |
Gets the | ||
Parameters | osid.id.Id | binId | the Id of the Bin |
Return | osid.resource.ResourceRelationshipSearchSession | a ResourceRelationshipSearchSession | |
Errors | NOT_FOUND | no bin found by the given Id | |
NULL_ARGUMENT | binId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsResourceRelationshipSearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsResourceRelationshipSearch() and
supportsVisibleFederation() are true | |
Method | getResourceRelationshipAdminSession | ||
Description |
Gets the | ||
Return | osid.resource.ResourceRelationshipAdminSession | a ResourceRelationshipAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsResourceRelationshipAdmin() is false | ||
Compliance | optional | This method must be implemented if
supportsResourceRelationshipAdmin() is true. | |
Method | getResourceRelationshipAdminSessionForBin | ||
Description |
Gets the | ||
Parameters | osid.id.Id | binId | the Id of the Bin |
Return | osid.resource.ResourceRelationshipAdminSession | a ResourceRelationshipAdminSession | |
Errors | NOT_FOUND | no bin found by the given Id | |
NULL_ARGUMENT | binId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsResourceRelationshipAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsResourceRelationshipAdmin() and
supportsVisibleFederation() are true | |
Method | getResourceRelationshipNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.resource.ResourceRelationshipReceiver | resourceRelationshipReceiver | the notification callback |
Return | osid.resource.ResourceRelationshipNotificationSession | a ResourceRelationshipNotificationSession | |
Errors | NULL_ARGUMENT | resourceRelationshipReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsResourceRelationshipNotification() is false
| ||
Compliance | optional | This method must be implemented if
supportsResourceRelationshipNotification() is true. | |
Method | getResourceRelationshipNotificationSessionForBin | ||
Description |
Gets the | ||
Parameters | osid.resource.ResourceRelationshipReceiver | resourceRelationshipReceiver | the notification callback |
osid.id.Id | binId | the Id of the Bin | |
Return | osid.resource.ResourceRelationshipNotificationSession | a ResourceRelationshipNotificationSession | |
Errors | NOT_FOUND | no bin found by the given Id | |
NULL_ARGUMENT | resourceRelationshipReceiver or binId is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsResourceRelationshiptNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsResourceRelationshipNotification() and
supportsVisibleFederation() are true | |
Method | getResourceRelationshipBinSession | ||
Description |
Gets the session for retrieving resource relationship to bin mappings. | ||
Return | osid.resource.ResourceRelationshipBinSession | a ResourceRelationshipBinSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsResourceRelationshipBin() is false | ||
Compliance | optional | This method must be implemented if supportsResourceRelationshipBin()
is true. | |
Method | getResourceRelationshipBinAssignmentSession | ||
Description |
Gets the session for assigning resource relationships to bin mappings. | ||
Return | osid.resource.ResourceRelationshipBinAssignmentSession | a ResourceRelationshipBinAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsResourceRelationshipBinAssignment() is false
| ||
Compliance | optional | This method must be implemented if
supportsResourceRelationshipBinAssignment() is true. | |
Method | getResourceRelationshipSmartBinSession | ||
Description |
Gets the session for managing dynamic resource relationship bins. | ||
Parameters | osid.id.Id | binId | the Id of the bin |
Return | osid.resource.ResourceRelationshipSmartBinSession | a ResourceRelationshipSmartBinSession | |
Errors | NOT_FOUND | binId not found | |
NULL_ARGUMENT | binId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsResourceRelationshipSmartBin() is false
| ||
Compliance | optional | This method must be implemented if
supportsResourceRelationshipSmartBin() is true. | |
Method | getBinLookupSession | ||
Description |
Gets the bin lookup session. | ||
Return | osid.resource.BinLookupSession | a BinLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsBinLookup() is false | ||
Compliance | optional | This method must be implemented if supportsBinLookup() is
true. | |
Method | getBinQuerySession | ||
Description |
Gets the bin query session. | ||
Return | osid.resource.BinQuerySession | a BinQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsBinQuery() is false | ||
Compliance | optional | This method must be implemented if supportsBinQuery() is
true. | |
Method | getBinSearchSession | ||
Description |
Gets the bin search session. | ||
Return | osid.resource.BinSearchSession | a BinSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsBinSearch() is false | ||
Compliance | optional | This method must be implemented if supportsBinSearch() is
true. | |
Method | getBinAdminSession | ||
Description |
Gets the bin administrative session for creating, updating and deleteing bins. | ||
Return | osid.resource.BinAdminSession | a BinAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsBinAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsBinAdmin() is
true. | |
Method | getBinNotificationSession | ||
Description |
Gets the notification session for subscribing to changes to a bin. | ||
Parameters | osid.resource.BinReceiver | binReceiver | the notification callback |
Return | osid.resource.BinNotificationSession | a BinNotificationSession | |
Errors | NULL_ARGUMENT | binReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBinNotification() is false | ||
Compliance | optional | This method must be implemented if supportsBinNotification()
is true. | |
Method | getBinHierarchySession | ||
Description |
Gets the bin hierarchy traversal session. | ||
Return | osid.resource.BinHierarchySession | a BinHierarchySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsBinHierarchy() is false | ||
Compliance | optional | This method must be implemented if supportsBinHierarchy() is
true. | |
Method | getBinHierarchyDesignSession | ||
Description |
Gets the bin hierarchy design session. | ||
Return | osid.resource.BinHierarchyDesignSession | a BinHierarchyDesignSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsBinHierarchyDesign() is false | ||
Compliance | optional | This method must be implemented if supportsBinHierarchyDesign()
is true. | |
Method | getResourceBatchManager | ||
Description |
Gets the | ||
Return | osid.resource.batch.ResourceBatchManager | a ResourceBatchManager | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsResourceBatch() is false | ||
Compliance | optional | This method must be implemented if supportsResourceBatch()
is true. | |
Method | getResourceDemographicManager | ||
Description |
Gets the | ||
Return | osid.resource.demographic.ResourceDemographicManager | a ResourceDemographicManager | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsResourceDemographic() is false | ||
Compliance | optional | This method must be implemented if supportsResourceDemographic()
is true. |