|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface FragmentLayoutService
Service interface for ContainerLayout
specific operations.
Method Summary | |
---|---|
FragmentLayout |
copyFragmentLayout(String oldFragmentLayoutID,
FragmentLayout newFragmentLayout)
Create a copy of the FragmentLayout identified by the oldFragmentLayoutID . |
FragmentLayout |
createFragmentLayout(FragmentLayout fragmentLayout)
Create a new FragmentLayout object. |
Boolean |
fragmentLayoutExists(String fragmentLayoutName)
Check if a FragmentLayout exists by the given name. |
List |
getAllFragmentLayouts(Query query)
List all FragmentLayout s filtered by the given Query . |
List |
getDependentLetters(String fragmentLayoutID)
Retrieve the list of Letter s dependent on the Form identified by the given
FragmentLayoutID . |
FragmentLayout |
getFragmentLayout(String fragmentLayoutID)
Fetch the FragmentLayout identified by the given FragmentLayoutID . |
boolean |
isReferenced(String fragmentLayoutID)
Check if this FragmentLayout is being referenced by any other asset (Letter). |
FragmentLayout |
markReadyToPublish(String fragmentLayoutID)
Mark as ready to publish the FragmentLayout identified by the given fragmentLayoutID . |
FragmentLayout |
parseFragmentLayout(FragmentLayout fragmentLayout)
Parses fragment layout and populates target areas, fields and tables in it. |
FragmentLayout |
publishFragmentLayout(String fragmentLayoutID)
Publish the FragmentLayout identified by the given FragmentLayoutID . |
FragmentLayout |
retrieveVersion(String fragmentLayoutId,
Date publishDate)
Returns the version of fragment layout that was published on or before the specified date. |
FragmentLayout |
revertToLastPublished(String fragmentLayoutId)
Reverts the fragment layout to the last published version. |
boolean |
updateDependencies(FragmentLayout oldFragmentLayout,
FragmentLayout newFragmentLayout)
Update the references of the old FragmentLayout oldFragmentLayout , in any dependent assets,
with the new FragmentLayout newFragmentLayout . |
boolean |
updateDependencies(FragmentLayout oldFragmentLayout,
FragmentLayout newFragmentLayout,
List clas,
Map claMap)
Update the references of the old FragmentLayout oldFragmentLayout , in any dependent assets,
with the new FragmentLayout newFragmentLayout . |
FragmentLayout |
updateFragmentLayout(FragmentLayout fragmentLayout)
Update the given FragmentLayout . |
Method Detail |
---|
Boolean fragmentLayoutExists(String fragmentLayoutName) throws ICCException
fragmentLayout
- Name of the FragmentLayout.
ICCException
List getAllFragmentLayouts(Query query) throws ICCException
FragmentLayout
s filtered by the given Query
.
query
- Query to select FragmentLayouts (supports only first level
attributes/properties of an object).FragmentLayout
objects
ICCException
Statement} and {@link Query}.
FragmentLayout markReadyToPublish(String fragmentLayoutID) throws ICCException
FragmentLayout
identified by the given fragmentLayoutID
.
fragmentLayoutID
- ID of the FragmentLayout
.
FragmentLayout
object marked for publishing
ICCException
FragmentLayout publishFragmentLayout(String fragmentLayoutID) throws ICCException
FragmentLayout
identified by the given FragmentLayoutID
.
fragmentLayoutID
- ID of the FragmentLayout
.
FragmentLayout
object
ICCException
FragmentLayout getFragmentLayout(String fragmentLayoutID) throws ICCException
FragmentLayout
identified by the given FragmentLayoutID
.
fragmentLayoutID
- ID of the FragmentLayout
to be fetched.
FragmentLayout
identified by the given FragmentLayoutID
.
ICCException
FragmentLayout createFragmentLayout(FragmentLayout fragmentLayout) throws ICCException
FragmentLayout
object.
fragmentLayout
- The FragmentLayout
to be created.
FragmentLayout
object
ICCException
FragmentLayout updateFragmentLayout(FragmentLayout fragmentLayout) throws ICCException
FragmentLayout
.
fragmentLayout
- FragmentLayout
object to be updated.
FragmentLayout
object.
ICCException
FragmentLayout copyFragmentLayout(String oldFragmentLayoutID, FragmentLayout newFragmentLayout) throws ICCException
FragmentLayout
identified by the oldFragmentLayoutID
.
newFragmentLayout
does not have content in it, the content of the original FragmentLayout
is set in it.
oldFragmentLayoutID
- ID of the original FragmentLayout
. Used to fetch the original content, if need be.newFragmentLayout
- copy of the original FragmentLayout (may have properties altered by the user)
FragmentLayout
.
ICCException
boolean isReferenced(String fragmentLayoutID) throws ICCException
FragmentLayoutID
- ID of the FragmentLayout
whose dependencies are to be fetched.
ICCException
List getDependentLetters(String fragmentLayoutID) throws ICCException
Letter
s dependent on the Form
identified by the given
FragmentLayoutID
.
FragmentLayoutID
- ID of the FragmentLayout
whose dependencies are to be fetched.
Letter
s which depend on the given FragmentLayout
.
ICCException
boolean updateDependencies(FragmentLayout oldFragmentLayout, FragmentLayout newFragmentLayout) throws ICCException
oldFragmentLayout
, in any dependent assets,
with the new FragmentLayout newFragmentLayout
.
oldFragmentLayout
- The old FragmentLayout object.newFragmentLayout
- The new FragmentLayout object, which should be set as the new reference.
ICCException
boolean updateDependencies(FragmentLayout oldFragmentLayout, FragmentLayout newFragmentLayout, List clas, Map claMap) throws ICCException
oldFragmentLayout
, in any dependent assets,
with the new FragmentLayout newFragmentLayout
.
oldFragmentLayout
- The old FragmentLayout object.newFragmentLayout
- The new FragmentLayout object, which should be set as the new reference.clas
- List of container layout assignment that are required to be updated.claMap
- Map of container layout assignment and their parent letters.
ICCException
FragmentLayout parseFragmentLayout(FragmentLayout fragmentLayout) throws ICCException
fragmentLayout
- FragmentLayout required to be parsed
FragmentLayout
populated with target areas, fields and tables.
ICCException
FragmentLayout revertToLastPublished(String fragmentLayoutId) throws ICCException
fragmentLayoutId
- The fragment layout ID.
ICCException
FragmentLayout retrieveVersion(String fragmentLayoutId, Date publishDate)
fragmentLayoutId
- The FragmentLayout ID.publishDate
- specifies the date for fetching published FragmentLayout.
ICCException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |