|
Oracle® Fusion Middleware Site Studio for External Applications Java API Reference 11g Release 1 (11.1.1) E17273-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.stellent.wcm.core.definition.placeholder.PlaceholderDefinition
public class PlaceholderDefinition
A placeholder definition that defines what is allowed in a placeholder along with default data to render the placeholder.
Nested Class Summary | |
---|---|
static class |
PlaceholderDefinition.Action |
Field Summary | |
---|---|
static java.lang.String |
APPROVE |
static java.lang.String |
DOC_INFO |
static java.lang.String |
DOC_INFO_UPDATE |
static java.lang.String |
MODIFY_METADATA |
static java.lang.String |
PREVIEW |
static java.lang.String |
REJECT |
static java.lang.String |
REMOVE_ASSOCIATION |
static java.lang.String |
RESET |
static java.lang.String |
SWITCH_DATA_FILE |
static java.lang.String |
SWITCH_REGION_TEMPLATE |
static java.lang.String |
UPDATE |
static java.lang.String |
VIEW_TRACKER_REPORT |
static java.lang.String |
VIEW_USAGE_REPORT |
Constructor Summary | |
---|---|
PlaceholderDefinition() Create an empty placeholder definition |
|
PlaceholderDefinition(oracle.stellent.wcm.core.definition.placeholder.model.PlaceholderDefinitionType model) Create a placeholder definition with the supplied properties and region schema view mapping |
Method Summary | |
---|---|
void |
addRegionDefinition(java.lang.String definitionName) Add a region definition reference to this placeholder config |
void |
addRegionTemplate(java.lang.String regionDefinition, java.lang.String template) Add a region definition to template mapping |
void |
addRegionTemplate(java.lang.String definitionName, java.lang.String templateName, boolean isDefault) Add a region definition to template mapping |
void |
addSubtemplate(java.lang.String contentID) Add the subtemplate to the list |
boolean |
containsRegionDefinition(java.lang.String definitionName) Determine if the given definitionName is mapped in this placeholder |
boolean |
containsRegionTemplate(java.lang.String definitionName, java.lang.String templateName) Determine if the region template is mapped to this definition |
boolean |
containsSubtemplate(java.lang.String templateName) Determine if the given subtemplate is in this placeholder |
java.lang.String |
getDefaultRegionTemplate(java.lang.String definitionName) Retrieve the default region template for the given definition |
java.lang.String |
getDescription() |
java.util.Map<java.lang.String,java.lang.Boolean> |
getFlagMap() Retrieve the actions settings as a map of action to boolean |
protected oracle.stellent.wcm.core.definition.placeholder.model.ComplexProperty |
getFlagsProperty() |
oracle.stellent.wcm.core.definition.placeholder.model.PlaceholderDefinitionType |
getModel() |
protected oracle.stellent.wcm.core.definition.placeholder.model.Property |
getProperty(java.lang.String name) |
java.util.Collection<java.lang.String> |
getRegionDefinitionNames() |
protected oracle.stellent.wcm.core.definition.placeholder.model.RegionDefinitionType |
getRegionDefinitionType(java.lang.String definitionName) |
java.util.List<java.lang.String> |
getRegionTemplates(java.lang.String definitionName) Retrieve the region views for the given definition name |
java.util.List<java.lang.String> |
getSubtemplates() |
protected oracle.stellent.wcm.core.definition.placeholder.model.SubTemplateType |
getSubtemplateType(java.lang.String contentID) |
boolean |
isActionSet(PlaceholderDefinition.Action action) Determine if the given action is set |
boolean |
isEmpty() |
void |
merge(PlaceholderDefinition placeholderDefinition) Merge the given placeholder definition into this definition |
void |
removeAction(PlaceholderDefinition.Action action) Remove an action from this definition |
void |
removeActions() Remove all the actions on this placeholder definition |
void |
removeRegionDefinition(java.lang.String definitionName) Remove the region definition and all associated templates |
void |
removeRegionTemplate(java.lang.String definitionName, java.lang.String templateName) Remove the region template view |
void |
removeSubtemplate(java.lang.String contentID) Remove a subtemplate from the list of available templates |
void |
setAction(PlaceholderDefinition.Action action, boolean value) Set the action to the given value |
void |
setDefaultRegionTemplate(java.lang.String regionDefinition, java.lang.String template) Set a template to be the default for a given definition name |
void |
setDescription(java.lang.String description) |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String UPDATE
public static final java.lang.String PREVIEW
public static final java.lang.String RESET
public static final java.lang.String DOC_INFO
public static final java.lang.String DOC_INFO_UPDATE
public static final java.lang.String SWITCH_DATA_FILE
public static final java.lang.String SWITCH_REGION_TEMPLATE
public static final java.lang.String MODIFY_METADATA
public static final java.lang.String APPROVE
public static final java.lang.String REJECT
public static final java.lang.String VIEW_USAGE_REPORT
public static final java.lang.String VIEW_TRACKER_REPORT
public static final java.lang.String REMOVE_ASSOCIATION
Constructor Detail |
---|
public PlaceholderDefinition()
public PlaceholderDefinition(oracle.stellent.wcm.core.definition.placeholder.model.PlaceholderDefinitionType model)
model
- the placeholder definition modelMethod Detail |
---|
public oracle.stellent.wcm.core.definition.placeholder.model.PlaceholderDefinitionType getModel()
public java.lang.String getDescription()
public void setDescription(java.lang.String description)
public boolean isEmpty()
public boolean containsRegionDefinition(java.lang.String definitionName)
definitionName
- the definition namepublic boolean containsSubtemplate(java.lang.String templateName)
templateName
- the template namepublic java.util.List<java.lang.String> getRegionTemplates(java.lang.String definitionName)
definitionName
- the region definition namepublic java.util.Collection<java.lang.String> getRegionDefinitionNames()
public void addRegionDefinition(java.lang.String definitionName)
definitionName
- the schema namepublic void removeRegionDefinition(java.lang.String definitionName)
definitionName
- the schema namepublic void addRegionTemplate(java.lang.String regionDefinition, java.lang.String template)
regionDefinition
- the region definition nametemplate
- the view namepublic void removeRegionTemplate(java.lang.String definitionName, java.lang.String templateName)
definitionName
- the definition nametemplateName
- the template name to removepublic boolean containsRegionTemplate(java.lang.String definitionName, java.lang.String templateName)
definitionName
- the definitiontemplateName
- the template namepublic void addRegionTemplate(java.lang.String definitionName, java.lang.String templateName, boolean isDefault)
definitionName
- the region schema nametemplateName
- the view nameisDefault
- if true, set this as the default view for this schemapublic java.lang.String getDefaultRegionTemplate(java.lang.String definitionName)
definitionName
- the definition namepublic void setDefaultRegionTemplate(java.lang.String regionDefinition, java.lang.String template)
regionDefinition
- the definition nametemplate
- the region templatepublic java.util.List<java.lang.String> getSubtemplates()
public void addSubtemplate(java.lang.String contentID)
contentID
- the content ID of the subtemplatepublic void removeSubtemplate(java.lang.String contentID)
contentID
- the content ID (dDocName) of the subtemplatepublic void merge(PlaceholderDefinition placeholderDefinition)
placeholderDefinition
- the placeholder definitionpublic boolean isActionSet(PlaceholderDefinition.Action action)
action
- the actionpublic java.util.Map<java.lang.String,java.lang.Boolean> getFlagMap()
public void setAction(PlaceholderDefinition.Action action, boolean value)
action
- the action to setvalue
- the valuepublic void removeAction(PlaceholderDefinition.Action action)
action
- the action to removepublic void removeActions()
protected oracle.stellent.wcm.core.definition.placeholder.model.Property getProperty(java.lang.String name)
protected oracle.stellent.wcm.core.definition.placeholder.model.ComplexProperty getFlagsProperty()
protected oracle.stellent.wcm.core.definition.placeholder.model.RegionDefinitionType getRegionDefinitionType(java.lang.String definitionName)
protected oracle.stellent.wcm.core.definition.placeholder.model.SubTemplateType getSubtemplateType(java.lang.String contentID)
|
Oracle® Fusion Middleware Site Studio for External Applications Java API Reference 11g Release 1 (11.1.1) E17273-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |