public interface RelationUpdater
IOObjects
. IOObject
types can be found in IOAtom
.
Note: No locks are required when calling methods in this interface. However, when dealing with relations one should always consider whether or not
it is wise to lock objects before adding, deleting or modifying these relations. Changes made without locks can be lost if another user has locked
one of the objects belonging to your relation. On the other hand, it is not good practice to always lock all objects since this will damage the workflow
of other processes running towards the Escenic API.Modifier and Type | Method and Description |
---|---|
boolean |
addArticleRelation(IORelation relation)
Creates a new relation between two articles.
|
boolean |
addArticleRelations(IORelation[] relations)
Adds a number of relations between two articles.
|
boolean |
addArticleRoleKeeper(IORelation relation)
Creates a new relation betweeen an article and a person.
|
boolean |
addArticlesToPool(IORelation[] relations)
Inserts a number of articles to a pool.
|
boolean |
addArticleToPool(IORelation relation)
Adds an article to a pool.
|
boolean |
addArticleToPoolWithPresentationEvent(IORelation relation)
Will do the same as addArticleToPool, but will send an event
of type OBJECT_MODIFIED for the Pool.
|
boolean |
addArticleToSection(Article article,
Section section)
Adds an article to a section.
|
boolean |
addArticleToSection(Article article,
Section section,
int priority)
Adds an article to a section with the given priority
|
boolean |
addArticleToTopic(IORelation relation)
Adds an article to a topic.
|
boolean |
addEntityToArticle(IORelation pRelation)
Creates a relation between an article and a
ReferenceEntity . |
boolean |
addMembersToProtectionDomain(Collection<? extends Member> pMember,
ProtectionDomain pDomain,
neo.xredsys.acl.Role pRole) |
boolean |
addMembersToProtectionDomain(Collection<? extends Member> pMember,
ProtectionDomain pDomain,
String pRole) |
boolean |
addMemberToEntry(Member member,
Section entry,
neo.xredsys.acl.Role role)
Gives a
Member a spesific role on the given Section . |
boolean |
addMemberToProtectionDomain(Member pMember,
ProtectionDomain pDomain,
neo.xredsys.acl.Role pRole) |
boolean |
addMemberToProtectionDomain(Member pMember,
ProtectionDomain pDomain,
String pRole) |
boolean |
addPersonToPublication(Person person,
Publication pub)
Adds the specified person to the publication in question.
|
boolean |
addPoolToSection(Pool pool,
Section section)
Creates a new relation between the given pool and section.
|
boolean |
addPublicationLayout(Publication pub,
int layoutId)
Deprecated.
method is not implemented
|
boolean |
addPublicationLayout(Publication pub,
Layout layout)
Deprecated.
|
boolean |
addUserGroupToSection(UserGroup userGroup,
Section section,
neo.xredsys.acl.Role role)
Gives this userGroup the specified role on this section.
|
boolean |
addUserGroupToSection(UserGroup userGroup,
Section section,
String role)
Deprecated.
use
addUserGroupToSection(UserGroup, Section, Role) instead. |
boolean |
addUserGroupToUserGroup(UserGroup userGroup,
UserGroup intoGroup)
Adds a group into the specified user group.
|
boolean |
addUserToGroup(Person person,
UserGroup group)
Adds the specified person to this group.
|
boolean |
addUserToIOObject(Person person,
IOObject ioObject,
String role)
Deprecated.
use
addUserToSection(Person, Section, Role) instead. |
boolean |
addUserToSection(Person person,
Section section,
neo.xredsys.acl.Role role)
Gives this person the specified role on this section.
|
boolean |
addUserToSection(Person person,
Section section,
String role)
Deprecated.
use
addUserToSection(Person, Section, Role) instead. |
boolean |
createRelation(IORelation relation)
Creates a new relation between two
IOObjects . |
boolean |
createRelations(IORelation[] relation) |
void |
deleteArticlesInSection(Section sec,
boolean recursive)
Removes all articles from the specified section.
|
boolean |
deleteRelation(IORelation relation)
Deletes an existing relation from the persistence layer.
|
boolean |
deleteRelations(IORelation[] relation) |
void |
deleteShortCuts(Section sec,
boolean recursive)
Removes all articles from pools belonging to the specified section.
|
void |
moveArticles(Section oldHomeSection,
Section targetSection)
Moves all articles from the specified section into the target section.
|
void |
moveShortCuts(Section oldSection,
Section targetSection)
Moves all articles from pools belonging to the specified section into the target section.
|
boolean |
removeAllArticlesFromPool(Pool pool)
Removes all articles belonging to the given pool.
|
void |
removeAllPublishedArticlesFromPool(Pool pool)
Removes all published articles from the given pool.
|
boolean |
removeArticleFromAllPools(int articleId)
Removes an article from all pools where it has the given article-pool state(codeId).
|
boolean |
removeArticleFromAllPools(int articleId,
int codeId)
Removes an article from all pools where it has the given article-pool state(codeId).
|
boolean |
removeArticleFromAllSections(Article article)
Removes this article from all sections.
|
boolean |
removeArticleFromAllSections(Article article,
int priority)
Removes an article from all sections where the relation(article-section) has the given priority.
|
boolean |
removeArticleFromPool(Article article,
Pool pool)
Removes an article from a pool
|
boolean |
removeArticleFromPool(IORelation relation)
Removes an existing relation between two
IOObjects . |
boolean |
removeArticleFromSection(Article article,
Section section)
Removes an article from a section, without deleting it.
|
boolean |
removeArticleFromTopic(IORelation relation)
Removes a specific article from a topic.
|
boolean |
removeArticleRelation(Article a1,
Article a2,
Type type)
Removes an existing relation between the two given articles.
|
boolean |
removeArticleRelation(IORelation relation)
Removes an existing relation between the two given articles.
|
boolean |
removeArticleRelations(Article article)
Removes all relations containg articles and the given article.
|
boolean |
removeArticleRelations(Article article,
boolean reverse)
Removes all relations containg articles and the given article.
|
boolean |
removeArticleRelations(IORelation[] relations,
boolean reverse)
Removes all relations containg articles and the given article.
|
boolean |
removeArticleRoleKeeper(Article article,
Person person)
Removes an existing relation between an article and a person.
|
boolean |
removeArticleRoleKeeper(Article article,
Person person,
Type roleType)
Removes an existing relation between an article and a person.
|
boolean |
removeArticleRoleKeeper(IORelation relation)
Removes an existing relation between an article and a person.
|
boolean |
removeArticlesFromEntity(ReferenceEntity ref)
Removes all relations containing the given
ReferenceEntity and an article. |
boolean |
removeArticlesFromEntity(ReferenceEntity ref,
Type[] types)
Removes all relations of the given types containing the given
ReferenceEntity and an article. |
boolean |
removeEntitiesFromArticle(Article article)
Removes all relations between the given article and related
ReferenceEntity objects. |
boolean |
removeEntitiesFromArticle(Article article,
ReferenceEntity ref)
Removes all relations from article to
ReferenceEntity . |
boolean |
removeEntitiesFromArticle(Article article,
ReferenceEntity ref,
Type[] types)
Removes all relations with the specified types from article to
ReferenceEntity . |
boolean |
removeEntitiesFromArticle(Article article,
Type[] types)
Removes all relations with the given types from this article to its related
ReferenceEntity objects. |
boolean |
removeEntitiesFromArticle(IORelation pRelation)
Remove a specified relations between an article an a
ReferenceEntity . |
boolean |
removeEntityFromArticle(IORelation pRelation)
Remove a specified relation between an article an a
ReferenceEntity . |
boolean |
removeEntryFromPool(IORelation relation)
Removes an existing relation between two
IOObjects . |
boolean |
removeMemberFromEntry(Member member,
Section entry,
neo.xredsys.acl.Role role)
Removes a
Members role on the given LDAPEntry . |
boolean |
removeMemberFromProtectionDomain(Member pMember,
ProtectionDomain pDomain,
neo.xredsys.acl.Role pRole) |
boolean |
removeMemberFromProtectionDomain(Member pMember,
ProtectionDomain pDomain,
String pRole) |
boolean |
removePersonArticleRoles(int articleId)
Removes all relations containing persons and the given article
|
boolean |
removePersonArticleRoles(int articleId,
String type)
Removes all relations containing persons and the given article
|
boolean |
removePersonFromPublication(Person person,
Publication pub)
Removes the specified person from the publication in question.
|
boolean |
removePublicationLayout(Publication pub,
int layoutId)
Deprecated.
method is not implemented
|
boolean |
removePublicationLayout(Publication pub,
Layout layout)
Deprecated.
|
boolean |
removeRoleKeeper(int referenceId)
Removes all roles that the specified person has on articles.
|
boolean |
removeSectionLayout(Section section,
Layout layout)
Deprecated.
method is not implemented
|
boolean |
removeUserFromGroup(Person person,
UserGroup group)
Removes the specified user from the group in question.
|
boolean |
removeUserFromIOObject(Person person,
IOObject ioObject,
String role)
Deprecated.
use
removeUserFromSection(Person, Section, Role) instead. |
boolean |
removeUserFromSection(Person person,
Section section,
neo.xredsys.acl.Role role)
Removes the specified user from the section in question.
|
boolean |
removeUserFromSection(Person person,
Section section,
String role)
Deprecated.
use
removeUserFromSection(Person, Section, Role) instead. |
boolean |
removeUserGroupFromSection(UserGroup userGroup,
Section section,
neo.xredsys.acl.Role role)
Removes this userGroups role on this section.
|
boolean |
removeUserGroupFromSection(UserGroup userGroup,
Section section,
String role)
Deprecated.
use
removeUserGroupFromSection(UserGroup, Section, Role) instead. |
boolean |
removeUserGroupFromUserGroup(UserGroup userGroup,
UserGroup intoGroup)
Removes a group from the specified user group.
|
boolean |
replaceArticleRelations(int articleId,
Collection rels)
Modifies, adds and removes article relations.
|
boolean |
replaceArticlesInPool(IORelation[] relations,
int codeId)
Removes all existing Articles( with a given Pool-state) from a given Pool.
|
boolean |
replaceEntitiesOnArticle(IORelation[] pRelations)
Removes all existing relations on this article before adding a number of new article relations.
|
boolean |
setMainArticleInTopic(IORelation relation)
Creates a new relation between an article and a topic.
|
boolean |
setPoolLayout(Pool pool,
Layout layout)
Deprecated.
method is not implemented
|
boolean |
setPublicationLayouts(Publication pub,
Layout[] layouts)
Deprecated.
method is not implemented
|
boolean |
setSectionLayouts(Section section,
Layout[] layouts)
Deprecated.
method is not implemented
|
boolean |
updateArticleEntityRelation(IORelation relation)
Updates an existing relation between a specific article and
ReferenceEntity . |
boolean |
updateArticlePoolRelation(IORelation relation)
Updates the given relation.
|
boolean |
updateArticleRelations(IORelation[] relations)
Updates a number of article-article relations.
|
boolean |
updateArticleRoleKeeper(IORelation relation)
Updates an existing relation between an article and a person
|
boolean |
updateRelation(IORelation relation)
Updates an existing relation between two
IOObjects |
boolean |
updateRelations(IORelation[] relation) |
boolean createRelation(IORelation relation) throws PersistentStoreException, NoSuchObjectException, IllegalOperationException
IOObjects
. IOObject
types can be found in IOAtom
.
The relation object must have the following attribute set:
Type
)
Integer
)
relation
- the relation to createPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if refering to an IOObject
that does not existIllegalOperationException
- if this user is not authorized to perform this actionboolean createRelations(IORelation[] relation) throws PersistentStoreException, NoSuchObjectException, IllegalOperationException
boolean updateRelation(IORelation relation) throws PersistentStoreException, NoSuchObjectException, IllegalOperationException
IOObjects
relation
- the relation to modifyPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if refering to an IOObject
that does not existIllegalOperationException
- if this user is not authorized to perform this actionboolean updateRelations(IORelation[] relation) throws PersistentStoreException, NoSuchObjectException, IllegalOperationException
boolean deleteRelation(IORelation relation) throws PersistentStoreException, NoSuchObjectException, IllegalOperationException
relation
- the relation to deletePersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if refering to an IOObject
that does not existIllegalOperationException
- if this user is not authorized to perform this actionboolean deleteRelations(IORelation[] relation) throws PersistentStoreException, NoSuchObjectException, IllegalOperationException
boolean addArticleToSection(Article article, Section section) throws PersistentStoreException, NoSuchObjectException
article
- the article that should be addedsection
- the section it should be added toPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if refering to an IOObject
that does not existboolean addArticleToSection(Article article, Section section, int priority) throws PersistentStoreException, NoSuchObjectException
article
- the article that should be addedsection
- the section it should be added topriority
- the priority of the new relationPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if refering to an IOObject
that does not existboolean addArticleToTopic(IORelation relation) throws PersistentStoreException, NoSuchObjectException, IllegalOperationException
relation
- the feature to be added to the ArticleToTopic attributePersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if refering to an IOObject
that does not existIllegalOperationException
- if this user is not authorized to perform this actionboolean removeArticleFromTopic(IORelation relation) throws PersistentStoreException, NoSuchObjectException, IllegalOperationException
relation
- the relation to removePersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if refering to an IOObject
that does not existIllegalOperationException
- if this user is not authorized to perform this actionboolean removeArticleFromSection(Article article, Section section) throws PersistentStoreException, NoSuchObjectException, IllegalOperationException
article
- the article that should be removedsection
- the section it should be removed fromPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if refering to an IOObject
that does not existIllegalOperationException
- if this user is not authorized to perform this actionboolean removeArticleFromAllSections(Article article) throws PersistentStoreException, NoSuchObjectException, IllegalOperationException
article
- the article to remove from all sectionsPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if refering to an IOObject
that does not existIllegalOperationException
- if this user is not authorized to perform this actionboolean removeArticleFromAllSections(Article article, int priority) throws PersistentStoreException, NoSuchObjectException, IllegalOperationException
article
- the article to remove from all sectionspriority
- the priority of the relations to removePersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if refering to an IOObject
that does not existIllegalOperationException
- if this user is not authorized to perform this actionboolean replaceArticlesInPool(IORelation[] relations, int codeId) throws PersistentStoreException, NoSuchObjectException, IllegalOperationException
relations
- the relations to addcodeId
- the type of poolentries to removePersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if refering to an IOObject
that does not existIllegalOperationException
- if this user is not authorized to perform this actionboolean addArticleToPool(IORelation relation) throws PersistentStoreException, NoSuchObjectException, IllegalOperationException
relation
- the relation to addPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if refering to an IOObject
that does not existIllegalOperationException
- if this user is not authorized to perform this actionboolean addArticleToPoolWithPresentationEvent(IORelation relation) throws PersistentStoreException, NoSuchObjectException, IllegalOperationException
boolean addArticlesToPool(IORelation[] relations) throws PersistentStoreException, NoSuchObjectException, IllegalOperationException
relations
- the relations to addPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if refering to an IOObject
that does not existIllegalOperationException
- if this user is not authorized to perform this actionboolean removeArticleFromPool(Article article, Pool pool) throws PersistentStoreException, NoSuchObjectException, IllegalOperationException
article
- the article to remove from poolpool
- the pool to remove the article fromPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if refering to an IOObject
that does not existIllegalOperationException
- if this user is not authorized to perform this actionboolean removeArticleFromPool(IORelation relation) throws PersistentStoreException, NoSuchObjectException, IllegalOperationException
IOObjects
. This method will remove all relations between
the two objects.relation
- the relation to removePersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if refering to an IOObject
that does not existIllegalOperationException
- if this user is not authorized to perform this actionboolean removeEntryFromPool(IORelation relation) throws PersistentStoreException, NoSuchObjectException, IllegalOperationException
IOObjects
. This method will only remove the given relation.relation
- the relation to removePersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if refering to an IOObject
that does not existIllegalOperationException
- if this user is not authorized to perform this actionboolean removeAllArticlesFromPool(Pool pool) throws PersistentStoreException, NoSuchObjectException, IllegalOperationException
pool
- the pool to remove all articles fromPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if refering to an IOObject
that does not existIllegalOperationException
- if this user is not authorized to perform this actionvoid removeAllPublishedArticlesFromPool(Pool pool) throws PersistentStoreException, NoSuchObjectException, IllegalOperationException
pool
- the pool to remove articles fromPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if refering to an IOObject
that does not existIllegalOperationException
- if this user is not authorized to perform this actionboolean updateArticlePoolRelation(IORelation relation) throws PersistentStoreException, NoSuchObjectException, IllegalOperationException
relation
- the relation to be modifiedPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if refering to an IOObject
that does not existIllegalOperationException
- if this user is not authorized to perform this actionboolean addEntityToArticle(IORelation pRelation) throws PersistentStoreException, NoSuchObjectException
ReferenceEntity
.
The relation object must have the following attributes set:
Type
)
Integer
)
pRelation
- the relation to addtrue
if successful, false
otherwisePersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if refering to an IOObject
that does not existIllegalArgumentException
- if pRelation
is null
, or
not of category IORelation.ArticleRefersToEntity
boolean replaceEntitiesOnArticle(IORelation[] pRelations) throws PersistentStoreException, NoSuchObjectException
Type
)
Integer
)
pRelations
- the relations to addPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if refering to an IOObject
that does not existIllegalArgumentException
- if pRelations
is null
, or
any element is not of category IORelation.ArticleRefersToEntity
boolean removeEntitiesFromArticle(Article article, ReferenceEntity ref) throws PersistentStoreException, NoSuchObjectException
ReferenceEntity
. Use with caution!!!article
- the article to remove relations fromref
- the ReferenceEntity
that will loose its relations with the given articlePersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if refering to an IOObject
that does not existboolean removeEntitiesFromArticle(Article article, ReferenceEntity ref, Type[] types) throws PersistentStoreException, NoSuchObjectException
ReferenceEntity
.
Use with caution!! If types == null, all relation types will be deletedarticle
- the article to remove entities fromref
- the entities to remove from articletypes
- the types of relations to removePersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if refering to an IOObject
that does not existboolean removeEntitiesFromArticle(IORelation pRelation) throws PersistentStoreException, NoSuchObjectException
ReferenceEntity
.pRelation
- the relation to removetrue
if successful, false
otherwisePersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if refering to an IOObject
that does not existIllegalArgumentException
- if pRelation
is null
, or
not of category IORelation.ArticleRefersToEntity
boolean removeEntityFromArticle(IORelation pRelation) throws PersistentStoreException, NoSuchObjectException
ReferenceEntity
.pRelation
- the relation to removetrue
if successful, false
otherwisePersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if refering to an IOObject
that does not existIllegalArgumentException
- if pRelation
is null
, or
not of category IORelation.ArticleRefersToEntity
boolean removeEntitiesFromArticle(Article article) throws PersistentStoreException, NoSuchObjectException
ReferenceEntity
objects.article
- the article to remove all related entities fromPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if refering to an IOObject
that does not existboolean removeEntitiesFromArticle(Article article, Type[] types) throws PersistentStoreException, NoSuchObjectException
ReferenceEntity
objects.article
- the article to remove entities fromtypes
- the types of relations to removePersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if refering to an IOObject
that does not existboolean removeArticlesFromEntity(ReferenceEntity ref) throws PersistentStoreException, NoSuchObjectException
ReferenceEntity
and an article.
Inline images will be removed if ReferenceEntity
is of type
ref
- the ReferenceEntity to remove relations fromPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if refering to an IOObject
that does not existboolean removeArticlesFromEntity(ReferenceEntity ref, Type[] types) throws PersistentStoreException, NoSuchObjectException
ReferenceEntity
and an article.ref
- the ReferenceEntity to remove relations fromtypes
- the types of relations to addPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if refering to an IOObject
that does not existboolean removeArticleFromAllPools(int articleId, int codeId) throws PersistentStoreException
articleId
- the id of the article to remove from poolscodeId
- the article-pool state of the relations to removePersistentStoreException
- if an error occurs in the persistence layerboolean removeArticleFromAllPools(int articleId) throws PersistentStoreException
articleId
- the id of the article to remove from poolsPersistentStoreException
- if an error occurs in the persistence layerboolean updateArticleEntityRelation(IORelation relation) throws PersistentStoreException, NoSuchObjectException, IllegalOperationException
ReferenceEntity
.relation
- the relation to modifyPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if refering to an IOObject
that does not existIllegalOperationException
- if this user is not authorized to perform this actionboolean addArticleRoleKeeper(IORelation relation) throws PersistentStoreException, NoSuchObjectException
Type
)
relation
- the relation to be addedPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if refering to an IOObject
that does not existboolean removeArticleRoleKeeper(Article article, Person person, Type roleType) throws PersistentStoreException, NoSuchObjectException
Type
objects can be found by calling TypeManager.getTypes(neo.xredsys.api.Type.Category)
.article
- the article that is related to the given personperson
- the person that is related to the given articleroleType
- the role this person has on the given article. Type
objects can be found by calling TypeManager.getTypes(neo.xredsys.api.Type.Category)
.PersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if refering to an IOObject
that does not existboolean removeArticleRoleKeeper(Article article, Person person) throws PersistentStoreException, NoSuchObjectException
article
- the article that is related to the given personperson
- the person that is related to the given articlePersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if refering to an IOObject
that does not existboolean removeArticleRoleKeeper(IORelation relation) throws PersistentStoreException, NoSuchObjectException
relation
- the relation to removePersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if refering to an IOObject
that does not existboolean removePersonArticleRoles(int articleId) throws PersistentStoreException
articleId
- the id of the article to remove relations fromPersistentStoreException
- if an error occurs in the persistence layerboolean removePersonArticleRoles(int articleId, String type) throws PersistentStoreException
articleId
- the id of the article to remove relations fromtype
- only remove relations of this type. Type can be one of
creator or author.PersistentStoreException
- if an error occurs in the persistence layerboolean updateArticleRoleKeeper(IORelation relation) throws PersistentStoreException, NoSuchObjectException
relation
- the relation to modifyPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if refering to an IOObject
that does not existboolean addArticleRelation(IORelation relation) throws PersistentStoreException, NoSuchObjectException
relation
- the relation to createPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if refering to an IOObject
that does not existboolean addArticleRelations(IORelation[] relations) throws PersistentStoreException, NoSuchObjectException
relations
- an Array containing relations between two articlesPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if refering to an IOObject
that does not existboolean updateArticleRelations(IORelation[] relations) throws PersistentStoreException, NoSuchObjectException
relations
- the relations to modifyPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if refering to an IOObject
that does not existboolean replaceArticleRelations(int articleId, Collection rels) throws PersistentStoreException
Collection will be removed.
articleId
- the id of the article to which relations will be replacedrels
- the relations to add and modifyPersistentStoreException
- if some store error occursboolean removeArticleRelations(Article article) throws PersistentStoreException, NoSuchObjectException
article
- the article to remove relations fromPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if refering to an IOObject
that does not existboolean removeArticleRelations(Article article, boolean reverse) throws PersistentStoreException, NoSuchObjectException
article
- the article to remove relations fromPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if refering to an IOObject
that does not existboolean removeArticleRelations(IORelation[] relations, boolean reverse) throws PersistentStoreException, NoSuchObjectException
relations
- the article to remove relations fromreverse
- false if removing only relation where article is source; true otherwisePersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if refering to an IOObject
that does not existboolean removeArticleRelation(Article a1, Article a2, Type type) throws PersistentStoreException, NoSuchObjectException
a1
- the first article in the relation to be removeda2
- the second article in the relation to be removedtype
- the type of relation to be removedPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if refering to an IOObject
that does not existboolean removeArticleRelation(IORelation relation) throws PersistentStoreException, NoSuchObjectException
relation
- the relation to removePersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if refering to an IOObject
that does not existboolean removeSectionLayout(Section section, Layout layout) throws PersistentStoreException, NoSuchObjectException
section
- the section in the relation to be removedlayout
- the layout in the relation to be removedPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if refering to an IOObject
that does not existboolean setSectionLayouts(Section section, Layout[] layouts) throws PersistentStoreException, NoSuchObjectException
section
- the section to be related with the given layoutslayouts
- the layouts to be related with the given sectionPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if refering to an IOObject
that does not existboolean addPoolToSection(Pool pool, Section section) throws PersistentStoreException, NoSuchObjectException, IllegalOperationException
pool
- the pool to be related with the given sectionsection
- the section to be related with the given poolPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if refering to an IOObject
that does not existIllegalOperationException
boolean setPoolLayout(Pool pool, Layout layout) throws PersistentStoreException, NoSuchObjectException
pool
- the pool to be related with the given layoutlayout
- the layout to be related with this poolPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if refering to an IOObject
that does not existboolean addPublicationLayout(Publication pub, Layout layout) throws PersistentStoreException, NoSuchObjectException
pub
- the publication to be related with the given layoutlayout
- the layout to be related with the given publicationPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if refering to an IOObject
that does not existboolean addPublicationLayout(Publication pub, int layoutId) throws PersistentStoreException, NoSuchObjectException
pub
- the publication to be related with the given layoutlayoutId
- the id of the layout to be related with the given publicationPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if refering to an IOObject
that does not existboolean removePublicationLayout(Publication pub, Layout layout) throws PersistentStoreException, NoSuchObjectException
pub
- the publication that is related with the given layoutlayout
- the layout that is related with the given publicationPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if refering to an IOObject
that does not existboolean removePublicationLayout(Publication pub, int layoutId) throws PersistentStoreException, NoSuchObjectException
pub
- the publication that is related to the given layoutlayoutId
- the layout that is related to the given publicationPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if refering to an IOObject
that does not existboolean setPublicationLayouts(Publication pub, Layout[] layouts) throws PersistentStoreException, NoSuchObjectException
pub
- the publication to be related with the given layoutslayouts
- the layouts to be related with this poolPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if refering to an IOObject
that does not existboolean setMainArticleInTopic(IORelation relation) throws PersistentStoreException, NoSuchObjectException, IllegalOperationException
relation
- the relation to createPersistentStoreException
- if an error occurs in the persistence layerNoSuchObjectException
- if refering to an IOObject
that does not existIllegalOperationException
- if relation is not of category IORelation.ArticleInTopic
boolean addUserToGroup(Person person, UserGroup group) throws PersistentStoreException
person
- the person to add to the specified groupgroup
- the group to add the specified person intoPersistentStoreException
- if some store error occurs@Deprecated boolean addUserToSection(Person person, Section section, String role) throws PersistentStoreException
addUserToSection(Person, Section, Role)
instead.person
- the person to get a role on this sectionsection
- the section to add this person into with the specified rolePersistentStoreException
- if an error occurs in the persistence layerboolean addUserToSection(Person person, Section section, neo.xredsys.acl.Role role) throws PersistentStoreException
person
- the person to get a role on this sectionsection
- the section to add this person into with the specified rolePersistentStoreException
- if an error occurs in the persistence layer@Deprecated boolean addUserGroupToSection(UserGroup userGroup, Section section, String role) throws PersistentStoreException
addUserGroupToSection(UserGroup, Section, Role)
instead.userGroup
- the userGroup to get a role on this sectionsection
- the section to add this userGroup into with the specified rolePersistentStoreException
- if an error occurs in the persistence layerboolean addUserGroupToSection(UserGroup userGroup, Section section, neo.xredsys.acl.Role role) throws PersistentStoreException
userGroup
- the userGroup to get a role on this sectionsection
- the section to add this userGroup into with the specified rolePersistentStoreException
- if an error occurs in the persistence layer@Deprecated boolean removeUserGroupFromSection(UserGroup userGroup, Section section, String role) throws PersistentStoreException
removeUserGroupFromSection(UserGroup, Section, Role)
instead.userGroup
- the userGroup to lose a role on this sectionsection
- the section to remove this userGroup from with the specified rolePersistentStoreException
- if an error occurs in the persistence layerboolean removeUserGroupFromSection(UserGroup userGroup, Section section, neo.xredsys.acl.Role role) throws PersistentStoreException
userGroup
- the userGroup to lose a role on this sectionsection
- the section to remove this userGroup from with the specified rolePersistentStoreException
- if an error occurs in the persistence layerboolean addUserGroupToUserGroup(UserGroup userGroup, UserGroup intoGroup) throws PersistentStoreException
userGroup
- the user group to insert into another user groupintoGroup
- the user group to insert another user group intoPersistentStoreException
- if an error occurs in the persistence layerboolean removeUserGroupFromUserGroup(UserGroup userGroup, UserGroup intoGroup) throws PersistentStoreException
userGroup
- the user group to remove from another user groupintoGroup
- the user group to remove another user group fromPersistentStoreException
- if an error occurs in the persistence layer@Deprecated boolean addUserToIOObject(Person person, IOObject ioObject, String role) throws PersistentStoreException, IllegalOperationException
addUserToSection(Person, Section, Role)
instead.IOObject
.person
- the person to get a role on this IOObject
ioObject
- the IOObject
to add this person into with the specified rolePersistentStoreException
- if an error occurs in the persistence layerIllegalOperationException
IOObject
boolean addPersonToPublication(Person person, Publication pub) throws PersistentStoreException
person
- the person to add to the publication in questionpub
- the publication to add the specified person intoPersistentStoreException
- if an error occurs in the persistence layerboolean removePersonFromPublication(Person person, Publication pub) throws PersistentStoreException
person
- the person to remove from the publication in questionpub
- the publication to remove the specified person fromPersistentStoreException
- if an error occurs in the persistence layerboolean removeUserFromGroup(Person person, UserGroup group) throws PersistentStoreException
person
- the user to remove from the group in questiongroup
- the group to remove the specified user fromPersistentStoreException
- if an error occurs in the persistence layer@Deprecated boolean removeUserFromSection(Person person, Section section, String role)
removeUserFromSection(Person, Section, Role)
instead.person
- the user to remove from the section in questionsection
- the section to remove the specified user fromPersistentStoreException
- if an error occurs in the persistence layerboolean removeUserFromSection(Person person, Section section, neo.xredsys.acl.Role role)
person
- the user to remove from the section in questionsection
- the section to remove the specified user fromPersistentStoreException
- if an error occurs in the persistence layer@Deprecated boolean removeUserFromIOObject(Person person, IOObject ioObject, String role) throws PersistentStoreException
removeUserFromSection(Person, Section, Role)
instead.IOObject
in question.person
- the user to remove from the IOObject
in questionioObject
- the IOObject
to remove the specified user fromPersistentStoreException
- if an error occurs in the persistence layerIOObject
boolean addMemberToEntry(Member member, Section entry, neo.xredsys.acl.Role role) throws PersistentStoreException, IllegalOperationException
Member
a spesific role on the given Section
.
Member
objects are typically users or groups. Section
objects are typically sectionsmember
- the member that will be given the specified role on the ldap entry in questionentry
- the ldap entry that the given member will recieve a role onrole
- the role that the given member will be given on the ldap entry in questionPersistentStoreException
- if an error occurs in the persistence layerIllegalOperationException
Member
boolean removeMemberFromEntry(Member member, Section entry, neo.xredsys.acl.Role role) throws PersistentStoreException
Members
role on the given LDAPEntry
.
Member
objects are typically users or groups. LDAPEntry
objects are typically sectionsmember
- the member that no longer will have the specified role on the ldap entry in questionentry
- the ldap entry that the given member no longer will have the specified role onrole
- the role that the given member no longer will have on the ldap entry in questionPersistentStoreException
- if an error occurs in the persistence layerMember
boolean removeRoleKeeper(int referenceId) throws PersistentStoreException
referenceId
- the id of the person that will have his article roles removedPersistentStoreException
- if an error occurs in the persistence layervoid moveShortCuts(Section oldSection, Section targetSection) throws IllegalOperationException
oldSection
- the section to move articles fromtargetSection
- the section to move articles toIllegalOperationException
- if trying to remove a relation that does not existvoid moveArticles(Section oldHomeSection, Section targetSection) throws IllegalOperationException
oldHomeSection
- the section to move articles fromtargetSection
- the section to move articles toIllegalOperationException
- if trying to remove a relation that does not existvoid deleteShortCuts(Section sec, boolean recursive) throws IllegalOperationException
sec
- the section to remove articles fromrecursive
- true if articles also should be removed from pools belonging to subsections;otherwise falseIllegalOperationException
- if trying to remove a relation that does not existvoid deleteArticlesInSection(Section sec, boolean recursive) throws IllegalOperationException
sec
- the section to remove articles fromrecursive
- true if articles also should be removed from subsections;otherwise falseIllegalOperationException
- if trying to remove a relation that does not existboolean addMemberToProtectionDomain(Member pMember, ProtectionDomain pDomain, String pRole) throws PersistentStoreException
PersistentStoreException
boolean addMembersToProtectionDomain(Collection<? extends Member> pMember, ProtectionDomain pDomain, String pRole) throws PersistentStoreException
PersistentStoreException
boolean addMemberToProtectionDomain(Member pMember, ProtectionDomain pDomain, neo.xredsys.acl.Role pRole) throws PersistentStoreException
PersistentStoreException
boolean removeMemberFromProtectionDomain(Member pMember, ProtectionDomain pDomain, String pRole) throws PersistentStoreException
PersistentStoreException
boolean removeMemberFromProtectionDomain(Member pMember, ProtectionDomain pDomain, neo.xredsys.acl.Role pRole) throws PersistentStoreException
PersistentStoreException
boolean addMembersToProtectionDomain(Collection<? extends Member> pMember, ProtectionDomain pDomain, neo.xredsys.acl.Role pRole) throws PersistentStoreException
PersistentStoreException
© 1998- 2021 Escenic AS