com.adobe.fd.fp.service

Interface PendingSignMetadataService

public interface PendingSignMetadataService

Service for providing CRUDL operation for metadata associated with pending sign instances

Author:

sharoon

Method Summary

Modifier and Type	Method and Description
boolean	deleteMetadata(String pendingSignID)
boolean	deleteProperty(String pendingSignID, String propertyName)
org.apache.sling.commons.json.JSONArray	getPendingSignInstances(String cutPoints) Get the pending sign instances of current logged-in user
String[]	getProperty(String pendingSignID, String propertyName)
org.apache.sling.commons.json.JSONObject	readPendingSignInstance(String pendingSignID, String cutPoints) Read the pending sign whose id is passed as input
org.apache.sling.commons.json.JSONObject	saveSignMetadata(Map<String,Object> metadataProperties)
org.apache.sling.commons.json.JSONArray	searchPendingSignInstances(Query query) Search pending sign instances as per the query object passed.

Method Detail

saveSignMetadata

org.apache.sling.commons.json.JSONObject saveSignMetadata(Map<String,Object> metadataProperties)
                                                   throws FormsPortalException

Parameters:

metadataProperties: - consists of all the metadata information regarding this pending sign instance. This api can also be used for update of instance provided instance ID is included in the map else new instance will be created

Returns:

The metadata object of pending sign form in JSON format. For adaptive form, this object will also be used for redirect URL creation

Throws:

FormsPortalException

deleteMetadata

boolean deleteMetadata(String pendingSignID)
                throws FormsPortalException

Parameters:

pendingSignID: - metadata identifier associated with this pending sign instance

Returns:

status of delete operation on pending sign instance's Metadata

Throws:

FormsPortalException

getPendingSignInstances

org.apache.sling.commons.json.JSONArray getPendingSignInstances(String cutPoints)
                                                         throws FormsPortalException

Get the pending sign instances of current logged-in user

Parameters:

cutPoints: - comma separated string of cutPoints that tells about what set of properties of a pending sign instance is expected in the response

Returns:

list of pending sign instance's metadata objects so that they could be shown on forms portal UI

Throws:

FormsPortalException

searchPendingSignInstances

org.apache.sling.commons.json.JSONArray searchPendingSignInstances(Query query)
                                                            throws FormsPortalException

Search pending sign instances as per the query object passed.

Parameters:

query - Objects containing constraints for searching the instances

Returns:

list of pending sign instances satisfying the search criteria.

Throws:

FormsPortalException

readPendingSignInstance

org.apache.sling.commons.json.JSONObject readPendingSignInstance(String pendingSignID,
                                                                 String cutPoints)
                                                          throws FormsPortalException

Read the pending sign whose id is passed as input

Parameters:

pendingSignID -

cutPoints - comma separated string of cutPoints that tells about what set of properties of a pending sign instance is expected in the response

Returns:

Throws:

FormsPortalException

getProperty

String[] getProperty(String pendingSignID,
                     String propertyName)
              throws FormsPortalException

Parameters:

pendingSignID: - identifier associated with this pending sign instance

propertyName: - name of the metadata property queried to get

Returns:

property value. In case this is a multivalued property, return a string array consisting of all the values. If this is a single valued property return an array with only one value. If this identifier associated with this pending sign instance doesn't have this property then return an empty array. NEVER RETURN NULL.

Throws:

FormsPortalException

deleteProperty

boolean deleteProperty(String pendingSignID,
                       String propertyName)
                throws FormsPortalException

Parameters:

pendingSignID: - identifier associated with this pending sign instance

propertyName: - name of the metadata property queried for deletion

Returns:

status of operation performed to delete property with name "propertyName"

Throws:

FormsPortalException