Package com.planet_ink.coffee_mud.Common.interfaces

Interface ClanPosition

All Superinterfaces:

java.lang.Cloneable, CMCommon, CMObject, java.lang.Comparable<CMObject>, Modifiable

All Known Implementing Classes:

DefaultClanPosition

public interface ClanPosition
extends Modifiable, CMCommon

A class for the characteristics of a position within a clan government.

Field Summary

Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

idConverter

Method Summary

Modifier and Type	Method	Description
Clan.Authority[]	getFunctionChart()	Gets the function chart.
java.lang.String	getID()	Gets the iD.
java.lang.String	getInnerMaskStr()	Gets the inner mask str.
double	getMax()	Gets the max members in this position.
java.lang.String	getName()	Gets the name.
java.lang.String	getPluralName()	Gets the plural name.
int	getRank()	Gets the rank.
int	getRoleID()	Gets the role id.
java.util.List<java.lang.String>	getTitleAwards()	Returns a list of titles granted to players of clans in this position.
boolean	isPublic()	Checks if is public.
void	setFunctionChart(Clan.Authority[] functionChart)	Sets the function chart.
void	setID(java.lang.String iD)	Sets the iD.
void	setInnerMaskStr(java.lang.String innerMaskStr)	Sets the inner mask str.
void	setMax(double max)	Sets the max members in this position.
void	setName(java.lang.String name)	Sets the name.
void	setPluralName(java.lang.String pluralName)	Sets the plural name.
void	setPublic(boolean isPublic)	Sets the public.
void	setRank(int rank)	Sets the rank.
void	setRoleID(int roleID)	Sets the role id.

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

copyOf, ID, initializeClass, name, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.Modifiable

getSaveStatIndex, getStat, getStatCodes, isStat, setStat

Method Detail

getID

java.lang.String getID()

Gets the iD.

Returns:

the iD

See Also:

setID(String)

setID

void setID(java.lang.String iD)

Sets the iD.

Parameters:

iD - the new iD

See Also:

getID()

getRoleID

int getRoleID()

Gets the role id.

Returns:

the role id

See Also:

setRoleID(int)

setRoleID

void setRoleID(int roleID)

Sets the role id.

Parameters:

roleID - the new role id

See Also:

getRoleID()

getRank

int getRank()

Gets the rank.

Returns:

the rank

See Also:

setRank(int)

setRank

void setRank(int rank)

Sets the rank.

Parameters:

rank - the new rank

See Also:

getRank()

getName

java.lang.String getName()

Gets the name.

Returns:

the name

See Also:

setName(String)

setName

void setName(java.lang.String name)

Sets the name.

Parameters:

name - the new name

See Also:

getName()

getPluralName

java.lang.String getPluralName()

Gets the plural name.

Returns:

the plural name

See Also:

setPluralName(String)

setPluralName

void setPluralName(java.lang.String pluralName)

Sets the plural name.

Parameters:

pluralName - the new plural name

See Also:

getPluralName()

getMax

double getMax()

Gets the max members in this position. A number >= 1.0 is an absolute number, while a number >= 0 but less than 1 is a percentage.

Returns:

the max

See Also:

setMax(double)

setMax

void setMax(double max)

Sets the max members in this position. A number >= 1.0 is an absolute number, while a number >= 0 but less than 1 is a percentage.

Parameters:

max - the new max

See Also:

getMax()

getInnerMaskStr

java.lang.String getInnerMaskStr()

Gets the inner mask str.

Returns:

the inner mask str

See Also:

setInnerMaskStr(String)

setInnerMaskStr

void setInnerMaskStr(java.lang.String innerMaskStr)

Sets the inner mask str.

Parameters:

innerMaskStr - the new inner mask str

See Also:

getInnerMaskStr()

isPublic

boolean isPublic()

Checks if is public.

Returns:

true, if is public

See Also:

setPublic(boolean)

setPublic

void setPublic(boolean isPublic)

Sets the public.

Parameters:

isPublic - the new public

See Also:

isPublic()

getTitleAwards

java.util.List<java.lang.String> getTitleAwards()

Returns a list of titles granted to players of clans in this position. Variables in the titles include: @x1 The Clan Name @x2 The Clan Government Name This list is manipulable.

Returns:

the clan base titles

getFunctionChart

Clan.Authority[] getFunctionChart()

Gets the function chart.

Returns:

the function chart

See Also:

setFunctionChart(com.planet_ink.coffee_mud.Common.interfaces.Clan.Authority[])

setFunctionChart

void setFunctionChart(Clan.Authority[] functionChart)

Sets the function chart.

Parameters:

functionChart - the new function chart

See Also:

getFunctionChart()