public interface Publication extends IOObject
Publication
objects in the
Escenic system. A PublicationTransaction
must be retrieved when you need to modify this
object.
A
IOAtom.ObjectType
ID_INVALID, OBJECTTYPE_AGREEMENTINFO, OBJECTTYPE_ARTICLE, OBJECTTYPE_CATALOG, OBJECTTYPE_CATEGORY, OBJECTTYPE_ENTITY, OBJECTTYPE_FORUM, OBJECTTYPE_LAYOUT, OBJECTTYPE_MAX, OBJECTTYPE_MIN, OBJECTTYPE_PERSON, OBJECTTYPE_POOL, OBJECTTYPE_POSTING, OBJECTTYPE_PRESENTATION_FORUM, OBJECTTYPE_PRESENTATION_POSTING, OBJECTTYPE_PRESENTATION_THREAD, OBJECTTYPE_PROFILE, OBJECTTYPE_PUBLICATION, OBJECTTYPE_SECTION, OBJECTTYPE_THREAD, OBJECTTYPE_TOPIC, OBJECTTYPE_UNKNOWN, OBJECTTYPE_USERGROUP
Modifier and Type | Method and Description |
---|---|
boolean |
addLayout(Layout l)
Adds the given layout to this publication.
|
int |
getAdvertisementId()
Deprecated.
not in use
|
List<Layout> |
getArticleLayouts()
Retrieves all article layouts that belong to this publication.
|
Collection |
getArticleTypes()
Retrieves all article types belonging to this publication.
|
List<Section> |
getAuxiliaryRootSections()
Retrieves the auxiliary root section of this publication.
|
Section |
getDefaultSection()
Retrieves the default section of this publication.
|
String |
getDynamoRoot()
Deprecated.
not in use
|
List |
getElementLayouts()
Deprecated.
no replacement
|
String |
getEncoding()
Retrieves the character encoding of this publication specified in feature.properties file otherwise uuses
default encoding ISO-8859-1.
|
String |
getFeature(String feature)
Retrieves the given feature from this publication.
|
Properties |
getFeatures()
Retrieves this publication's features.
|
List<Layout> |
getGridLayouts()
Deprecated.
replaced by layout groups, not available in this class.
|
String |
getHistory()
Deprecated.
not in use
|
String |
getInformation()
Deprecated.
not in use
|
String |
getIsbn()
Retrieves the ISBN number of this publication, as entered when the publication was created.
|
String |
getIssn()
Retrieves the ISSN number of the publication, as entered when the publication was created.
|
Layout[] |
getLayouts()
Retrieves all layout that belong to this publications.
|
List |
getLayouts(Type t)
Retrieves all layouts of the given type that belong to this publication.
|
String |
getName()
Returns the name of this publication.
|
int |
getPublisherId()
Retrieves the publisher id of this publication.
|
Publication |
getRelatedPublication(Type pPublicationType)
Deprecated.
The related publication aka friendly publication concept is not used any more.
Add the appropriate
ProtectionDomain and list of roles to the user instead. |
InputStream |
getResourceAsStream(String pResourceName)
Retrieve a publication resource from the database.
|
List<String> |
getResourceNames()
Returns a list of Strings, each of which denote an existing resource in this publication.
|
List<String> |
getResourceNames(String pFilter)
Returns a list of Strings, each of which denote an existing resource in this publication.
|
String |
getRoot()
Retrieves the root directory of this publication.
|
Section |
getRootSection()
Retrieves the root section of this publication.
|
List<Layout> |
getSectionLayouts()
Retrieves all section layouts that belong to this publication.
|
Vector |
getSections()
Retrieves all sections that belong to this section.
|
int |
getSubscriptionId()
Deprecated.
not in use
|
Type |
getType()
Retrieves the type of this publication.
|
String |
getUrl()
Retrieves the url of this publication.
|
boolean |
hasRelatedPublication(Type pPublicationType)
Deprecated.
The related publication aka friendly publication concept is not used any more.
Add the appropriate
ProtectionDomain and list of roles to the user instead. |
boolean |
hasSection(int pSectionId)
Checks whether or not this publication contains the specified section.
|
boolean |
hasSection(String pSectionUniqeName)
Checks whether or not this publication contains the specified section.
|
boolean |
hasSection(String pSource,
String pSourceId)
Checks whether or not this publication contains the specified section.
|
boolean |
removeLayout(Layout l)
Removes the given layout from this publication.
|
void |
scanPublicationLayouts()
Deprecated.
no replacement
|
boolean |
setLayouts(Layout[] l)
Sets the layouts in this publication.
|
breakAndLock, createTransaction, getChecksum, getHashKey, getId, getLockKeeper, getObjectType, getOwnerPublicationId, getProtectionDomain, getProtectionDomains, isLocked, isPreview, isValid, lock, lock, lock, lock, refresh
Collection getArticleTypes()
Collection
PersistentStoreException
- if an error occurs in the persistence layerCollection
Layout[] getLayouts() throws PersistentStoreException, NoSuchObjectException
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existLayout
List getElementLayouts()
List<Layout> getSectionLayouts()
@Deprecated List<Layout> getGridLayouts()
List<Layout> getArticleLayouts()
List getLayouts(Type t)
boolean addLayout(Layout l) throws PersistentStoreException, NoSuchObjectException
Layout
already exists in the publication, nothing happens.l
- the type of layout to addPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existLayout
boolean removeLayout(Layout l) throws PersistentStoreException, NoSuchObjectException
l
- the layout to removePersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existLayout
boolean setLayouts(Layout[] l) throws PersistentStoreException, NoSuchObjectException
l
- the layouts to add to this publicationPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existLayout
Section getRootSection() throws PersistentStoreException, NoSuchObjectException
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existSection
List<Section> getAuxiliaryRootSections() throws PersistentStoreException
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existSection getDefaultSection() throws PersistentStoreException, NoSuchObjectException
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existSection
String getHistory() throws PersistentStoreException, NoSuchObjectException
String getInformation() throws PersistentStoreException, NoSuchObjectException
String getIsbn() throws PersistentStoreException, NoSuchObjectException
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existString getIssn() throws PersistentStoreException, NoSuchObjectException
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existString getName() throws PersistentStoreException, NoSuchObjectException
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existString getRoot() throws PersistentStoreException, NoSuchObjectException
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existString getDynamoRoot() throws PersistentStoreException, NoSuchObjectException
int getAdvertisementId() throws PersistentStoreException, NoSuchObjectException
int getSubscriptionId() throws PersistentStoreException, NoSuchObjectException
int getPublisherId() throws PersistentStoreException, NoSuchObjectException
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existProperties getFeatures() throws PersistentStoreException, NoSuchObjectException
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existProperties
String getFeature(String feature) throws PersistentStoreException, NoSuchObjectException
feature
- the feature to retrievePersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existvoid scanPublicationLayouts() throws PersistentStoreException, NoSuchObjectException
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existVector getSections() throws PersistentStoreException, NoSuchObjectException
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existboolean hasSection(String pSectionUniqeName)
pSectionUniqeName
- the section to search forboolean hasSection(String pSource, String pSourceId)
pSource
- the source of the section to search forpSourceId
- the source id of the section to search forboolean hasSection(int pSectionId)
pSectionId
- the id of the section to search forInputStream getResourceAsStream(String pResourceName) throws PersistentStoreException
pResourceName
- The name of the resource, which must start with a forward slash ('/').PersistentStoreException
- if an error occurs in the persistence layerPublicationTransaction.getResourceOutputStream(String)
List<String> getResourceNames() throws PersistentStoreException
PersistentStoreException
- if an error occurs in the persistence layerList<String> getResourceNames(String pFilter) throws PersistentStoreException
pFilter
- a filter to apply to the resource namesPersistentStoreException
- if an error occurs in the persistence layerString getEncoding() throws PersistentStoreException, NoSuchObjectException
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existString getUrl() throws PersistentStoreException, NoSuchObjectException
PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if trying to retrieve an object that does not existType getType()
PersistentStoreException
- if an error occurs in the persistence layerType
@Deprecated Publication getRelatedPublication(Type pPublicationType) throws PersistentStoreException, NoSuchObjectException, UnsupportedOperationException
ProtectionDomain
and list of roles to the user instead.UnsupportedOperationException
- always.PersistentStoreException
NoSuchObjectException
@Deprecated boolean hasRelatedPublication(Type pPublicationType) throws PersistentStoreException, UnsupportedOperationException
ProtectionDomain
and list of roles to the user instead.UnsupportedOperationException
- always.PersistentStoreException
© 1998- 2018 Stibo DX