unlimited.fc.server.api

Class ResourceGrantedToFolder

java.lang.Object

unlimited.fc.server.api.LinkState

unlimited.fc.server.api.ResourceGrantedToFolder

public class ResourceGrantedToFolder
extends LinkState

Title: FileCatalyst Direct Server API

Description: Class that describes a resource (group, user) which has access to a virtual folder. A type switch (ENUM) indicates what type of object has access to the folder. Permissions are not modifiable via this object, nor are they persisted. Calls to the Server API need to be made in order to modify on the server any permission set. Allows viewing/editing of permissions by API caller without exposing the inner permission classes.

Copyright: Copyright (c) 2013

Company: Unlimi-Tech Software Inc.

Since:

v3.1

Version:

1.0

Author:

Christian Charette, ccharette

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ResourceGrantedToFolder.ResourceType Title: FileCatalyst Direct Server API

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getDetails() Returns the details of the resource.
java.lang.String	getFolderName() Returns the folder name (not label) to uniquely identify a virtual folder in the database (PK).
java.lang.String	getName() Get the resource name.
int	getPermission() Return permission set to user or group (as int value -- see PermissionsContainer.generatePermission() to translate into boolean values)
int	hashCode()
boolean	isGroupLink() Returns true if the resource is a group
boolean	isUserLink() Returns true if the resource is a user
java.lang.String	toString() Write out ResourceGrantedToFolder object to string.

Methods inherited from class unlimited.fc.server.api.LinkState

getUsageState

Methods inherited from class java.lang.Object

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

Method Detail

getPermission

public int getPermission()

Return permission set to user or group (as int value -- see PermissionsContainer.generatePermission() to translate into boolean values)

Returns:

the permission granted to the group.

toString

public java.lang.String toString()

Write out ResourceGrantedToFolder object to string. Used for debugging.

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()

getFolderName

public java.lang.String getFolderName()

Returns the folder name (not label) to uniquely identify a virtual folder in the database (PK).

Returns:

virtual folder name.

getName

public java.lang.String getName()

Get the resource name. If this is of type user, than this will return the user name. If the resource is a group, than the group name is returned identifying the group.

Specified by:

getName in class LinkState

Returns:

resource name.

getDetails

public java.lang.String getDetails()

Returns the details of the resource. If the resource is a user, than the user full-name will be returned. If the resource is a group, than group description is returned.

Returns:

resource detail

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

isUserLink

public boolean isUserLink()

Returns true if the resource is a user

Returns:

true if the resource is a user

isGroupLink

public boolean isGroupLink()

Returns true if the resource is a group

Returns:

true if the resource is a group