com.canto.cumulus.prefs

Class AssetRelation

java.lang.Object

com.canto.cumulus.prefs.BaseManager

com.canto.cumulus.prefs.AssetRelation

public class AssetRelation
extends BaseManager

This class stores the settings for a single asset relation.

Since:

10.0.1

Nested Class Summary

Nested classes/interfaces inherited from class com.canto.cumulus.prefs.BaseManager

BaseManager.PackEntryChangeListener, BaseManager.RegistryEntry

Field Summary

Fields inherited from class com.canto.cumulus.prefs.BaseManager

TYPE_EJP, TYPE_NATIVE

Method Summary

Methods

Modifier and Type	Method and Description
GUID	getAssetRelationID() Returns the asset relation id of this asset relation.
java.lang.String	getDescription(int languageID, boolean useFallback) Returns the description of this asset relation.
java.lang.String	getDirectionNameToChild(int languageID, boolean useFallback) Returns the direction name of this asset relation.
java.lang.String	getDirectionNameToMaster(int languageID, boolean useFallback) Returns the direction name of this asset relation.
java.lang.String	getName(int languageID, boolean useFallback) Returns the name of this asset relation.
java.lang.String	getName(int languageID, boolean useFallback, boolean useRelationIDAsFallback) Returns the name of this asset relation.
RestrictionsList	getRestrictionsList() Returns the list of roles and users that are allowed to assign this asset relation if isRestricted() returns true.
java.lang.String	getTabNameToChild(int languageID, boolean useFallback) Returns the direction name of this asset relation.
java.lang.String	getTabNameToMaster(int languageID, boolean useFallback) Returns the tab name of this asset relation.
boolean	getTreatAsMaster() Returns whether this asset relation is treated as master.
boolean	isRestricted() Returns whether this asset relation is restricted to roles and users.
void	setDescription(int languageID, java.lang.String description) Sets the description of this asset relation for the given language.
void	setDirectionNameToChild(int languageID, java.lang.String directionName) Sets the direction name of this asset relation for the given language.
void	setDirectionNameToMaster(int languageID, java.lang.String directionName) Sets the direction name of this asset relation for the given language.
void	setName(int languageID, java.lang.String name) Sets the name of this asset relation for the given language.
void	setRestricted(boolean restricted) Sets this asset relation is restricted to roles and users.
void	setTabNameToChild(int languageID, java.lang.String tabName) Sets the tab name of this asset relation for the given language.
void	setTabNameToMaster(int languageID, java.lang.String tabName) Sets the tab name of this asset relation for the given language.
void	setTreatAsMaster(boolean treatAsMaster) Sets this asset relation to treat as master.

Methods inherited from class com.canto.cumulus.prefs.BaseManager

addChangeListener, addChangeListener, addGlobalChangeListener, addPackListener, forgetPush, getPack, isShared, popPack, pushPack, removeChangeListener, removeChangeListener, removeGlobalChangeListener, removePackListener, save, save, toString, writeAsXML

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getAssetRelationID

public GUID getAssetRelationID()

Returns the asset relation id of this asset relation.

Returns:

id of this asset relation

getTreatAsMaster

public boolean getTreatAsMaster()

Returns whether this asset relation is treated as master.

Returns:

asset relation treat as master

setTreatAsMaster

public void setTreatAsMaster(boolean treatAsMaster)

Sets this asset relation to treat as master.

Parameters:

treatAsMaster - true if this asset relation should be treated as master

isRestricted

public boolean isRestricted()

Returns whether this asset relation is restricted to roles and users.

Returns:

asset relation restricted

setRestricted

public void setRestricted(boolean restricted)

Sets this asset relation is restricted to roles and users.

Parameters:

restricted - true if this asset relation should be restricted to roles and users

getRestrictionsList

public RestrictionsList getRestrictionsList()

Returns the list of roles and users that are allowed to assign this asset relation if isRestricted() returns true.

Returns:

list of roles and users that are allowed to assign this asset relation

getName

public java.lang.String getName(int languageID,
                       boolean useFallback)

Returns the name of this asset relation.

Parameters:

languageID - the language to get

Returns:

name of this asset relation

setName

public void setName(int languageID,
           java.lang.String name)

Sets the name of this asset relation for the given language.

Parameters:

languageID - the language to set

name - the name to set

getName

public java.lang.String getName(int languageID,
                       boolean useFallback,
                       boolean useRelationIDAsFallback)

Returns the name of this asset relation.

Parameters:

languageID - the language to get

Returns:

name of this asset relation

setDescription

public void setDescription(int languageID,
                  java.lang.String description)

Sets the description of this asset relation for the given language.

Parameters:

languageID - the language to set

description - the description to set

getDescription

public java.lang.String getDescription(int languageID,
                              boolean useFallback)

Returns the description of this asset relation.

Parameters:

languageID - the language to get

Returns:

description of this asset relation

setDirectionNameToChild

public void setDirectionNameToChild(int languageID,
                           java.lang.String directionName)

Sets the direction name of this asset relation for the given language.

Parameters:

languageID - the language to set

directionName - the direction name to set

getDirectionNameToChild

public java.lang.String getDirectionNameToChild(int languageID,
                                       boolean useFallback)

Returns the direction name of this asset relation.

Parameters:

languageID - the language to get

Returns:

direction name of this asset relation

setDirectionNameToMaster

public void setDirectionNameToMaster(int languageID,
                            java.lang.String directionName)

Sets the direction name of this asset relation for the given language.

Parameters:

languageID - the language to set

directionName - the direction name to set

getDirectionNameToMaster

public java.lang.String getDirectionNameToMaster(int languageID,
                                        boolean useFallback)

Returns the direction name of this asset relation.

Parameters:

languageID - the language to get

Returns:

direction name of this asset relation

setTabNameToChild

public void setTabNameToChild(int languageID,
                     java.lang.String tabName)

Sets the tab name of this asset relation for the given language.

Parameters:

languageID - the language to set

tabName - the tab name to set

Since:

10.1

getTabNameToChild

public java.lang.String getTabNameToChild(int languageID,
                                 boolean useFallback)

Returns the direction name of this asset relation.

Parameters:

languageID - the language to get

Returns:

tab name of this asset relation

Since:

10.1

setTabNameToMaster

public void setTabNameToMaster(int languageID,
                      java.lang.String tabName)

Sets the tab name of this asset relation for the given language.

Parameters:

languageID - the language to set

tabName - the tab name to set

Since:

10.1

getTabNameToMaster

public java.lang.String getTabNameToMaster(int languageID,
                                  boolean useFallback)

Returns the tab name of this asset relation.

Parameters:

languageID - the language to get

Returns:

tab name of this asset relation

Since:

10.1