Interface | osid.room.construction.batch.ProjectBatchAdminSession | ||
---|---|---|---|
Implements | osid.room.construction.ProjectAdminSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a The Once a batch of For updates, Once a batch of The delete operations delete | ||
Method | getProjectFormsForCreate | ||
Description |
Gets the project forms for creating a bunch of new projects. A project form is returned for each supplied building. | ||
Parameters | osid.id.IdList | buildingIds | a list of building Ids |
osid.type.Type[] | projectRecordTypes | array of project record types to be included in each create operation or an empty list if none | |
Return | osid.room.construction.batch.ProjectBatchFormList | the project forms | |
Errors | NOT_FOUND | a buildingId is not found | |
NULL_ARGUMENT | buildingid or projectRecordTypes is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to request forms with given record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createProjects | ||
Description |
Creates a new set of | ||
Parameters | osid.room.construction.batch.ProjectBatchFormList | projectForms | the project forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | projectForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProjectFormsForUpdate | ||
Description |
Gets the project forms for updating an existing set of projects. A new project form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | projectIds | the Ids of the Project |
Return | osid.room.construction.batch.ProjectBatchFormList | the project form | |
Errors | NOT_FOUND | a projectId is not found | |
NULL_ARGUMENT | projectIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateProjects | ||
Description |
Updates existing projects. This method returns an error
if the entire operation fails. Otherwise, the status of an
individual update operation is indicated in the | ||
Parameters | osid.room.construction.batch.ProjectBatchFormList | projectForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | projectForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllProjects | ||
Description |
Deletes all | ||
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteProjects | ||
Description |
Deletes projects for the given | ||
Parameters | osid.id.IdList | projectIds | the Ids of the projects to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | projectIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteProjectsForBuilding | ||
Description |
Deletes all projects for a building. | ||
Parameters | osid.id.Id | buildingId | a building Id |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | buildingId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteIneffectiveProjectsByDate | ||
Description |
Deletes projects expired before the given date. | ||
Parameters | osid.calendaring.DateTime | date | a date |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | date is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasProjects | ||
Description |
Adds an | ||
Parameters | osid.transaction.batch.AliasRequestList | aliasRequests | the alias requests |
Return | osid.transaction.batch.AliasResponseList | the alias responses | |
Errors | NULL_ARGUMENT | aliasRequests is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |