unlimited.fc.server.api

Class UserGroupContainer

java.lang.Object

unlimited.fc.server.api.UserGroupContainer

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable

public class UserGroupContainer
extends java.lang.Object
implements java.lang.Cloneable, java.lang.Comparable

Title: FileCatalyst Direct Server API

Description: Container class that holds user group data. Allows viewing of User Group by API caller without exposing the inner User Group classes.

Copyright: Copyright (c) 2013

Company: Unlimi-Tech Software Inc.

Since:

v3.1

Version:

1.0

Author:

Christian Charette, ccharette

Constructor Summary

Constructors

Constructor and Description
UserGroupContainer(java.lang.String name, java.lang.String description, boolean enabled) Default constructor.

Method Summary

Modifier and Type	Method and Description
UserGroupContainer	clone() Clone method
int	compareTo(java.lang.Object o) Custom compare to method for this object
boolean	equals(java.lang.Object obj) Custom equals method for the object
java.lang.String	getDescription() Get the user group description
java.lang.String	getName() Returns the group name visible in the remote administration console
int	hashCode() Custom hash-code method for this object
boolean	isEnabled() If the user group is enabled or not.
void	setDescription(java.lang.String description) Modify the user group description
void	setEnabled(boolean enabled) Set the user group to be enabled or disabled.
void	setName(java.lang.String name) Modify the name of the user group
java.lang.String	toString() Write out UserGroupContainer object to string.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UserGroupContainer

public UserGroupContainer(java.lang.String name,
                          java.lang.String description,
                          boolean enabled)

Default constructor.

Parameters:

name - Name of the group as it appears to an administrator.

description - Description of the user group

enabled - TRUE if the user group is currently enabled, FALSE if the group is disabled.

Method Detail

clone

public UserGroupContainer clone()

Clone method

Overrides:

clone in class java.lang.Object

Returns:

getName

public java.lang.String getName()

Returns the group name visible in the remote administration console

Returns:

the name

setName

public void setName(java.lang.String name)

Modify the name of the user group

Parameters:

name - the name to set

getDescription

public java.lang.String getDescription()

Get the user group description

Returns:

the description

setDescription

public void setDescription(java.lang.String description)

Modify the user group description

Parameters:

description - the description to set

isEnabled

public boolean isEnabled()

If the user group is enabled or not.

Returns:

TRUE if the user group is currently enabled, FALSE if the group is disabled.

setEnabled

public void setEnabled(boolean enabled)

Set the user group to be enabled or disabled.

Parameters:

enabled - the enabled to set

hashCode

public int hashCode()

Custom hash-code method for this object

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Custom equals method for the object

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Write out UserGroupContainer object to string. Used for debugging.

Overrides:

toString in class java.lang.Object

Returns:

String

compareTo

public int compareTo(java.lang.Object o)

Custom compare to method for this object

Specified by:

compareTo in interface java.lang.Comparable