Interface PublicationTemplate
-
- All Known Implementing Classes:
PublicationTemplateImpl
public interface PublicationTemplate
A PublicationTemplate describes a set of publication records built on a same template. A PublicationTemplate groups :- a RecordTemplate which describes the built records.
- a RecordSet of records built on this template,
- an update Form used to create and update the publication items
- a view Form used to show the publications.
- a search form used to search the publication records.
- a result search view form to add publication records inside search result display
-
-
Field Summary
Fields Modifier and Type Field Description static String
DEFAULT_THUMBNAIL
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description List<String>
getApplications()
String
getDescription()
List<String>
getDomains()
String
getExternalId()
List<String>
getFieldsForFacets()
Returns all field names which can generate a search facetString
getFileName()
List<String>
getGroups()
List<String>
getInstances()
String
getName()
RecordSet
getRecordSet()
Returns the RecordSet of all the records built from this template.RecordTemplate
getRecordTemplate()
Returns the RecordTemplate of the publication data item.Form
getSearchForm()
Returns the Form used to search the records built from this template.Form
getSearchResultForm()
Returns the Form used to view the search result records built from this template.List<String>
getSpaces()
String
getThumbnail()
Form
getUpdateForm()
Returns the Form used to create and update the records built from this template.XmlForm
getUpdateFormAsXMLOne()
Returns the XML Form used to create and update the records built from this template.Form
getViewForm()
Returns the Form used to view the records built from this template.boolean
isDataEncrypted()
boolean
isDirectoryUsage()
boolean
isLocked()
Is this publication template locked, and so not modifiable or deletable?boolean
isRestrictedVisibility()
boolean
isRestrictedVisibilityToApplication()
boolean
isRestrictedVisibilityToInstance()
boolean
isRestrictedVisibilityToSpace()
boolean
isSearchable()
Is the publication records described by this template can be searchable?boolean
isUpdateLayerExist()
boolean
isViewLayerExist()
boolean
isVisible()
Is this publication template visible to others?boolean
isVisibleToDomain(String domainId)
boolean
isVisibleToUser(String userId)
void
setExternalId(String externalId)
-
-
-
Field Detail
-
DEFAULT_THUMBNAIL
static final String DEFAULT_THUMBNAIL
- See Also:
- Constant Field Values
-
-
Method Detail
-
getRecordTemplate
RecordTemplate getRecordTemplate() throws PublicationTemplateException
Returns the RecordTemplate of the publication data item.- Throws:
PublicationTemplateException
-
getRecordSet
RecordSet getRecordSet() throws PublicationTemplateException
Returns the RecordSet of all the records built from this template.- Throws:
PublicationTemplateException
-
getUpdateForm
Form getUpdateForm() throws PublicationTemplateException
Returns the Form used to create and update the records built from this template.- Throws:
PublicationTemplateException
-
getUpdateFormAsXMLOne
XmlForm getUpdateFormAsXMLOne() throws PublicationTemplateException
Returns the XML Form used to create and update the records built from this template. Even if an HTML layer exists (HTMLForm), the XML one is returned.- Returns:
- the XMLForm
- Throws:
PublicationTemplateException
-
getViewForm
Form getViewForm() throws PublicationTemplateException
Returns the Form used to view the records built from this template.- Throws:
PublicationTemplateException
-
getSearchForm
Form getSearchForm() throws PublicationTemplateException
Returns the Form used to search the records built from this template.- Throws:
PublicationTemplateException
-
setExternalId
void setExternalId(String externalId)
-
getExternalId
String getExternalId()
-
getName
String getName()
-
getDescription
String getDescription()
-
getThumbnail
String getThumbnail()
-
getFileName
String getFileName()
-
isVisible
boolean isVisible()
Is this publication template visible to others?- Returns:
- true if it is visible, false otherwise.
-
isLocked
boolean isLocked()
Is this publication template locked, and so not modifiable or deletable?- Returns:
- true if it is locked, false otherwise.
-
isSearchable
boolean isSearchable()
Is the publication records described by this template can be searchable?- Returns:
- true if the records are searchable, false othersise.
-
getSearchResultForm
Form getSearchResultForm() throws PublicationTemplateException
Returns the Form used to view the search result records built from this template.- Throws:
PublicationTemplateException
-
getFieldsForFacets
List<String> getFieldsForFacets()
Returns all field names which can generate a search facet- Returns:
- a List of field name
-
isRestrictedVisibility
boolean isRestrictedVisibility()
-
isRestrictedVisibilityToSpace
boolean isRestrictedVisibilityToSpace()
-
isRestrictedVisibilityToApplication
boolean isRestrictedVisibilityToApplication()
-
isRestrictedVisibilityToInstance
boolean isRestrictedVisibilityToInstance()
-
isVisibleToUser
boolean isVisibleToUser(String userId)
-
isVisibleToDomain
boolean isVisibleToDomain(String domainId)
-
isDataEncrypted
boolean isDataEncrypted()
-
isViewLayerExist
boolean isViewLayerExist()
-
isUpdateLayerExist
boolean isUpdateLayerExist()
-
isDirectoryUsage
boolean isDirectoryUsage()
-
-