atavism.agis.objects
Class Guild

java.lang.Object
  atavism.agis.objects.Guild

All Implemented Interfaces:

java.io.Serializable

public class Guild
extends java.lang.Object
implements java.io.Serializable

The Guild class handles an instance of a guild. It keeps track of the guilds members and ranks.

Author:

Andrew Harrison

See Also:

Serialized Form

Nested Class Summary

class	Guild.GuildMember
class	Guild.GuildRank

Constructor Summary

Guild()

Guild(int guildID, java.lang.String guildName, int factionID, java.util.ArrayList<java.lang.String> rankNames, java.util.ArrayList<java.util.ArrayList<java.lang.String>> rankPermissions, OID leaderOid, java.util.ArrayList<OID> initiates)

Method Summary

void	addMember(int memberID, OID memberOid, java.lang.String name, int rank, int level, java.lang.String note) Adds a member from the data in the database.
void	addNewMember(OID memberOid, java.lang.String name, int level)
void	addRank(int rankID, java.lang.String rankName, int rankLevel, java.util.ArrayList<java.lang.String> permissions) Adds a rank from the data in the database.
AccountDatabase	getAccountDatabase()
int	getFaction()
int	getGuildID()
Guild.GuildMember	getGuildMember(OID memberOid)
java.lang.String	getGuildName()
java.util.ArrayList<Guild.GuildMember>	getMembers()
java.lang.String	getMOTD()
java.lang.String	getOMOTD()
Guild.GuildRank	getRank(int rankID)
Guild.GuildRank	getRankByLevel(int rankID)
java.util.ArrayList<Guild.GuildRank>	getRanks()
void	handleCommand(OID oid, java.lang.String commandType, OID targetOid, java.lang.String commandData) This is the core function of the Guild class.
boolean	hasPermission(OID oid, java.lang.String command) This function checks the players rank to see if they can perform the requested command.
void	memberLevel(OID memberOid, int level)
boolean	memberLoggedIn(OID memberOid)
void	memberLoggedOut(OID memberOid)
boolean	processGuildDisband(OID memberOid)
void	sendGuildChat(OID senderOid, java.lang.String message)
void	sendGuildData(OID targetOid)
void	sendMemberData(Guild.GuildMember updatedMember, java.lang.String action)
void	sendMOTD()
void	sendRankData()
void	sendRemovedFromGuildData(OID targetOid)
protected void	SendTargetedGuildMessage(OID target, java.lang.String message)
void	setAccountDatabase(AccountDatabase aDB)
void	setFaction(int factionID)
void	setGuildID(int guildID)
void	setGuildName(java.lang.String guildName)
void	setMembers(java.util.ArrayList<Guild.GuildMember> members)
void	setMOTD(java.lang.String motd)
void	setOMOTD(java.lang.String omotd)
void	setRanks(java.util.ArrayList<Guild.GuildRank> ranks)

Methods inherited from class java.lang.Object

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

Constructor Detail

Guild

public Guild()

Guild

public Guild(int guildID,
             java.lang.String guildName,
             int factionID,
             java.util.ArrayList<java.lang.String> rankNames,
             java.util.ArrayList<java.util.ArrayList<java.lang.String>> rankPermissions,
             OID leaderOid,
             java.util.ArrayList<OID> initiates)

Method Detail

addRank

public void addRank(int rankID,
                    java.lang.String rankName,
                    int rankLevel,
                    java.util.ArrayList<java.lang.String> permissions)

Adds a rank from the data in the database. Should be called during the loading phase of the Guild.

Parameters:

rankID -

rankName -

rankLevel -

permissions -

addMember

public void addMember(int memberID,
                      OID memberOid,
                      java.lang.String name,
                      int rank,
                      int level,
                      java.lang.String note)

Adds a member from the data in the database. Should be called during the loading phase of the Guild.

Parameters:

memberID -

memberOid -

name -

rank -

level -

note -

addNewMember

public void addNewMember(OID memberOid,
                         java.lang.String name,
                         int level)

getGuildMember

public Guild.GuildMember getGuildMember(OID memberOid)

memberLoggedIn

public boolean memberLoggedIn(OID memberOid)

memberLoggedOut

public void memberLoggedOut(OID memberOid)

memberLevel

public void memberLevel(OID memberOid,
                        int level)

handleCommand

public void handleCommand(OID oid,
                          java.lang.String commandType,
                          OID targetOid,
                          java.lang.String commandData)

This is the core function of the Guild class. Whenever someone issues a guild command this function will take it, along with some form of data and then decide which function should be run from there.

Parameters:

commandType: - a string identifying the type of command

commandData: - data needed to carry out the command

hasPermission

public boolean hasPermission(OID oid,
                             java.lang.String command)

This function checks the players rank to see if they can perform the requested command.

Parameters:

oid: - the identifier of the player who issued the command

command: - the command issued by the player

Returns:

processGuildDisband

public boolean processGuildDisband(OID memberOid)

getRank

public Guild.GuildRank getRank(int rankID)

getRankByLevel

public Guild.GuildRank getRankByLevel(int rankID)

sendGuildData

public void sendGuildData(OID targetOid)

sendRemovedFromGuildData

public void sendRemovedFromGuildData(OID targetOid)

sendMemberData

public void sendMemberData(Guild.GuildMember updatedMember,
                           java.lang.String action)

sendRankData

public void sendRankData()

sendMOTD

public void sendMOTD()

sendGuildChat

public void sendGuildChat(OID senderOid,
                          java.lang.String message)

SendTargetedGuildMessage

protected void SendTargetedGuildMessage(OID target,
                                        java.lang.String message)

setGuildID

public void setGuildID(int guildID)

getGuildID

public int getGuildID()

setGuildName

public void setGuildName(java.lang.String guildName)

getGuildName

public java.lang.String getGuildName()

setFaction

public void setFaction(int factionID)

getFaction

public int getFaction()

setRanks

public void setRanks(java.util.ArrayList<Guild.GuildRank> ranks)

getRanks

public java.util.ArrayList<Guild.GuildRank> getRanks()

setMembers

public void setMembers(java.util.ArrayList<Guild.GuildMember> members)

getMembers

public java.util.ArrayList<Guild.GuildMember> getMembers()

setMOTD

public void setMOTD(java.lang.String motd)

getMOTD

public java.lang.String getMOTD()

setOMOTD

public void setOMOTD(java.lang.String omotd)

getOMOTD

public java.lang.String getOMOTD()

setAccountDatabase

public void setAccountDatabase(AccountDatabase aDB)

getAccountDatabase

public AccountDatabase getAccountDatabase()