com.adobe.fd.ccm.ccr.ccrDocumentInstance.api.services

Interface CCRDocumentInstanceService

public interface CCRDocumentInstanceService

CCRDocumentInstanceService interface provides various operations over draftInstanceCCRDocumentInstance which represents the temporary state and data as Document

Method Summary

Modifier and Type	Method and Description
CCRDocumentInstance	get(String draftId) Get API for the retrieving the data for saved draft.
List<CCRDocumentInstance>	getAll(String userId, Date creationTime, Date updateTime, Map<String,Object> optionsParams) Get API for retrieving all the saved draft.
String	save(CCRDocumentInstance ccrDocumentInstance) Save API for saving the current dataXML of Agent UI.
void	update(CCRDocumentInstance ccrDocumentInstance) Update API for updating the current dataXML of already saved Draft.

Method Detail

save

String save(CCRDocumentInstance ccrDocumentInstance)
     throws CCRDocumentException

Save API for saving the current dataXML of Agent UI.

Parameters:

ccrDocumentInstance - - CCRDocumentInstance

Returns:

unique draftId

Throws:

CCRDocumentException

update

void update(CCRDocumentInstance ccrDocumentInstance)
     throws CCRDocumentException

Update API for updating the current dataXML of already saved Draft.

Parameters:

ccrDocumentInstance - - CCRDocumentInstance

Throws:

CCRDocumentException

get

CCRDocumentInstance get(String draftId)
                 throws CCRDocumentException

Get API for the retrieving the data for saved draft.

Parameters:

draftId - - unique draftId

Returns:

CCRDocumentInstance for given draftId.

Throws:

CCRDocumentException

getAll

List<CCRDocumentInstance> getAll(String userId,
                                 Date creationTime,
                                 Date updateTime,
                                 Map<String,Object> optionsParams)
                          throws CCRDocumentException

Get API for retrieving all the saved draft.

Returns:

list of CCRDocumentInstance for all saved draft.

Throws:

CCRDocumentException