com.communote.server.core.vo.user.group

Class ExternalGroupVO

java.lang.Object

com.communote.server.core.vo.user.group.GroupVO

com.communote.server.core.vo.user.group.ExternalGroupVO

All Implemented Interfaces:

Serializable

public class ExternalGroupVO
extends GroupVO
implements Serializable

Extended VO for external user groups.

Author:

Communote GmbH - http://www.communote.com/

See Also:

Serialized Form

Property Summary

Type	Property and Description
boolean	isMergeOnAdditional Gets the value of the property mergeOnAdditionalProperty.

Constructor Summary

Constructors

Constructor and Description
ExternalGroupVO()
ExternalGroupVO(ExternalGroupVO otherBean) Copies constructor from other ExternalGroupVO
ExternalGroupVO(String externalId, String externalSystemId, String name)
ExternalGroupVO(String externalId, String externalSystemId, String additionalProperty, String name, String alias, String description)

Method Summary

Modifier and Type	Method and Description
void	copy(ExternalGroupVO otherBean) Copies all properties from the argument value object into this value object.
String	getAdditionalProperty() an optional member holding some additional data for the group.
String	getExternalId() ID that identifies a group within the external system
String	getExternalSystemId() ID that uniquely identifies an external system.
boolean	isMergeOnAdditionalProperty() Gets the value of the property mergeOnAdditionalProperty.
void	setAdditionalProperty(String additionalProperty)
void	setExternalId(String externalId)
void	setExternalSystemId(String externalSystemId)
void	setMergeOnAdditionalProperty(boolean merge) Whether the additional property should be treated like a unique identifier of an external group.

Methods inherited from class com.communote.server.core.vo.user.group.GroupVO

copy, getAlias, getDescription, getName, setAlias, setDescription, setName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Property Detail

isMergeOnAdditional

public boolean isMergeOnAdditionalProperty

Gets the value of the property mergeOnAdditionalProperty.

Constructor Detail

ExternalGroupVO

public ExternalGroupVO()

ExternalGroupVO

public ExternalGroupVO(ExternalGroupVO otherBean)

Copies constructor from other ExternalGroupVO

Parameters:

otherBean - , cannot be null

Throws:

NullPointerException - if the argument is null

ExternalGroupVO

public ExternalGroupVO(String externalId,
                       String externalSystemId,
                       String name)

ExternalGroupVO

public ExternalGroupVO(String externalId,
                       String externalSystemId,
                       String additionalProperty,
                       String name,
                       String alias,
                       String description)

Method Detail

copy

public void copy(ExternalGroupVO otherBean)

Copies all properties from the argument value object into this value object.

getAdditionalProperty

public String getAdditionalProperty()

an optional member holding some additional data for the group. The interpretation depends on the external system. For LDAP it would hold the DN for example.

getExternalId

public String getExternalId()

ID that identifies a group within the external system

getExternalSystemId

public String getExternalSystemId()

ID that uniquely identifies an external system.

isMergeOnAdditionalProperty

public boolean isMergeOnAdditionalProperty()

Gets the value of the property mergeOnAdditionalProperty.

setAdditionalProperty

public void setAdditionalProperty(String additionalProperty)

setExternalId

public void setExternalId(String externalId)

setExternalSystemId

public void setExternalSystemId(String externalSystemId)

setMergeOnAdditionalProperty

public void setMergeOnAdditionalProperty(boolean merge)

Whether the additional property should be treated like a unique identifier of an external group. If set to true an existing external group should first be searched by the externalId and if not found by the additionalProperty. This will help to update an existing external group when the mapping for the externalId changed.

Parameters:

merge - true if the additional property should be treated like a unique identifier and can be used to find and merge an existing external group