OSID - osid.process.ProcessProfile Service Interface Definition

Interface	osid.process.ProcessProfile
Implements	`osid.OsidProfile`
Description	The state profile describes interoperability among state services.
Method	supportsVisibleFederation
Description	Tests if federation is visible.
Return	`boolean`		`true` if visible federation is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsState
Description	Tests if retrieving mappings of state and `Ids` is supported.
Return	`boolean`		`true` if state mapping retrieval is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsStateAssignment
Description	Tests if managing mappings of states and `Ids` is supported.
Return	`boolean`		`true` if state assignment is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsStateChangeNotification
Description	Tests if subscirbing to state change notifications is supported.
Return	`boolean`		`true` if state change notification is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsStateLookup
Description	Tests if state lookup is supported.
Return	`boolean`		`true` if state lookup is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsStateQuery
Description	Tests if state query is supported.
Return	`boolean`		`true` if state query is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsStateSearch
Description	Tests if state search is supported.
Return	`boolean`		`true` if state search is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsStateAdmin
Description	Tests if state administration is supported.
Return	`boolean`		`true` if state administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsStateSequencing
Description	Tests if state sequencing is supported.
Return	`boolean`		`true` if state sequencing is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsStateNotification
Description	Tests if state notification is supported. Messages may be sent when states are created, modified, or deleted.
Return	`boolean`		`true` if state notification is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProcessLookup
Description	Tests if process lookup is supported.
Return	`boolean`		`true` if process lookup is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProcessQuery
Description	Tests if process query is supported.
Return	`boolean`		`true` if process query is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProcessSearch
Description	Tests if process search is supported.
Return	`boolean`		`true` if process search is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProcessAdmin
Description	Tests if process administration is supported.
Return	`boolean`		`true` if process administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProcessNotification
Description	Tests if process notification is supported. Messages may be sent when `Process` objects are created, deleted or updated. Notifications for states within processes are sent via the state notification session.
Return	`boolean`		`true` if process notification is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProcessHierarchy
Description	Tests if a process hierarchy traversal is supported.
Return	`boolean`		`true` if a process hierarchy traversal is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProcessHierarchyDesign
Description	Tests if a process hierarchy design is supported.
Return	`boolean`		`true` if a process hierarchy design is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getStateRecordTypes
Description	Gets all the state record types supported.
Return	`osid.type.TypeList`		the list of supported state record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsStateRecordType
Description	Tests if a given state record type is supported.
Parameters	`osid.type.Type`	`stateRecordType`	the state type
Return	`boolean`		`true` if the state record type is supported `,` `false` otherwise
Errors	NULL_ARGUMENT		`stateRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getStateSearchRecordTypes
Description	Gets all the state search record types supported.
Return	`osid.type.TypeList`		the list of supported state search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsStateSearchRecordType
Description	Tests if a given state search type is supported.
Parameters	`osid.type.Type`	`stateSearchRecordType`	the state search type
Return	`boolean`		`true` if the state search record type is supported `,` `false` otherwise
Errors	NULL_ARGUMENT		`stateRecordSearchType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getProcessRecordTypes
Description	Gets all the process record types supported.
Return	`osid.type.TypeList`		the list of supported process record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsProcessRecordType
Description	Tests if a given process record type is supported.
Parameters	`osid.type.Type`	`processRecordType`	the process record type
Return	`boolean`		`true` if the process record type is supported `,` `false` otherwise
Errors	NULL_ARGUMENT		`processRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getProcessSearchRecordTypes
Description	Gets all the process search record types supported.
Return	`osid.type.TypeList`		the list of supported process search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsProcessSearchRecordType
Description	Tests if a given process search record type is supported.
Parameters	`osid.type.Type`	`processSearchRecordType`	the process search record type
Return	`boolean`		`true` if the process search record type is supported `,` `false` otherwise
Errors	NULL_ARGUMENT		`processSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.