org.kuali.student.common.ui.client.service
Interface DocumentRpcService

All Superinterfaces:

BaseRpcService, com.google.gwt.user.client.rpc.RemoteService

All Known Implementing Classes:

DocumentRpcGwtServlet

@RemoteServiceRelativePath(value="rpcservices/DocumentRpcService")
public interface DocumentRpcService
extends BaseRpcService

Method Summary

StatusInfo	addDocumentCategoryToDocument(String documentId, String documentCategoryKey)
StatusInfo	deleteDocument(String documentId)
StatusInfo	deleteRefDocRelation(String docRelationId)
StatusInfo	deleteRefDocRelationAndOrphanedDoc(String docRelationId, String documentId)
DocumentInfo	getDocument(String documentId)
List<DocumentInfo>	getDocumentsByIdList(List<String> documentIdList)
List<RefDocRelationInfo>	getRefDocIdsForRef(String refObjectTypeKey, String refObjectId)
Boolean	isAuthorizedUploadDocuments(String id, String referenceTypeKey) Check for authorization to upload documents
StatusInfo	removeDocumentCategoryFromDocument(String documentId, String documentCategoryKey)
DocumentInfo	updateDocument(String documentId, DocumentInfo documentInfo)

Methods inherited from interface org.kuali.student.common.ui.client.service.BaseRpcService

getObjectStructure, getObjectTypes, getSearchCriteriaType, getSearchCriteriaTypes, getSearchResultType, getSearchResultTypes, getSearchType, getSearchTypes, getSearchTypesByCriteria, getSearchTypesByResult, search

Method Detail

getDocument

DocumentInfo getDocument(String documentId)
                         throws Exception

Throws:

Exception

getDocumentsByIdList

List<DocumentInfo> getDocumentsByIdList(List<String> documentIdList)
                                        throws Exception

Throws:

Exception

deleteDocument

StatusInfo deleteDocument(String documentId)
                          throws Exception

Throws:

Exception

updateDocument

DocumentInfo updateDocument(String documentId,
                            DocumentInfo documentInfo)
                            throws Exception

Throws:

Exception

addDocumentCategoryToDocument

StatusInfo addDocumentCategoryToDocument(String documentId,
                                         String documentCategoryKey)
                                         throws Exception

Throws:

Exception

removeDocumentCategoryFromDocument

StatusInfo removeDocumentCategoryFromDocument(String documentId,
                                              String documentCategoryKey)
                                              throws Exception

Throws:

Exception

isAuthorizedUploadDocuments

Boolean isAuthorizedUploadDocuments(String id,
                                    String referenceTypeKey)

Check for authorization to upload documents

Parameters:

id - identifier of the object

referenceTypeKey - reference type key of the object

deleteRefDocRelation

StatusInfo deleteRefDocRelation(String docRelationId)
                                throws Exception

Throws:

Exception

deleteRefDocRelationAndOrphanedDoc

StatusInfo deleteRefDocRelationAndOrphanedDoc(String docRelationId,
                                              String documentId)
                                              throws Exception

Throws:

Exception

getRefDocIdsForRef

List<RefDocRelationInfo> getRefDocIdsForRef(String refObjectTypeKey,
                                            String refObjectId)
                                            throws Exception

Throws:

Exception