Interface | osid.personnel.OrganizationAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create an For updates, The delete operations delete This session includes an | ||
Method | getRealmId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Realm Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getRealm | ||
Description |
Gets the | ||
Return | osid.personnel.Realm | the realm | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canCreateOrganizations | ||
Description |
Tests if this user can create organizations. A return
of true does not guarantee successful authorization. A
return of false indicates that it is known creating an
| ||
Return | boolean | false if Organization creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateOrganizationWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | organizationRecordTypes | array of organization record types |
Return | boolean | true if Organization creation using the
specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | organizationRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getOrganizationFormForCreate | ||
Description |
Gets the organization form for creating new organizations. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | organizationRecordTypes | array of organization record types to be included in the create operation or an empty list if none |
Return | osid.personnel.OrganizationForm | the organization form | |
Errors | NULL_ARGUMENT | organizationRecordTypes is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | cannot get form for requested record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createOrganization | ||
Description |
Creates a new | ||
Parameters | osid.personnel.OrganizationForm | organizationForm | the form for this Organization |
Return | osid.personnel.Organization | the new Organization | |
Errors | ILLEGAL_STATE | organizationForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | organizationForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | organizationForm did not originate from
getOrganizationFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateOrganizations | ||
Description |
Tests if this user can update organizations. A return
of true does not guarantee successful authorization. A
return of false indicates that it is known updating an
| ||
Return | boolean | false if Organization modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getOrganizationFormForUpdate | ||
Description |
Gets the organization form for updating an existing organization. A new organization form should be requested for each update transaction. | ||
Parameters | osid.id.Id | organizationId | the Id of the Organization |
Return | osid.personnel.OrganizationForm | the organization form | |
Errors | NOT_FOUND | organizationId is not found | |
NULL_ARGUMENT | organizationId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateOrganization | ||
Description |
Updates an existing organization. | ||
Parameters | osid.personnel.OrganizationForm | organizationForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | organizationForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | organizationForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | organizationForm did not originate from
getOrganizationFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteOrganizations | ||
Description |
Tests if this user can delete organizations. A return
of true does not guarantee successful authorization. A
return of false indicates that it is known deleting an
| ||
Return | boolean | false if Organization deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteOrganization | ||
Description |
Deletes an | ||
Parameters | osid.id.Id | organizationId | the Id of the Organization to remove |
Errors | NOT_FOUND | organizationId not found | |
NULL_ARGUMENT | organizationId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageOrganizationAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Organization aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasOrganization | ||
Description |
Adds an | ||
Parameters | osid.id.Id | organizationId | the Id of an Organization |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is in use as a primary Id | |
NOT_FOUND | organizationId not found | ||
NULL_ARGUMENT | organizationId or aliasId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |