com.appiancorp.suiteapi.administration

Class Folder

java.lang.Object

com.appiancorp.suiteapi.administration.Folder

All Implemented Interfaces:

LocalId, java.io.Serializable

Deprecated.

This class pertains to the legacy admin console, which will be replaced by the Appian Administration Console over the coming releases.

@Deprecated
public class Folder
extends java.lang.Object
implements LocalId, java.io.Serializable

This class represents a folder in the Administration Console.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Folder() Deprecated.

Method Summary

Modifier and Type	Method and Description
Folder	copyNonLocalizedFieldsOnly() Deprecated. Creates and returns a new Folder object.
Page[]	getAccessiblePages() Deprecated.
java.lang.String	getDescription() Deprecated. Returns the description of the folder.
java.lang.Long	getId() Deprecated. Returns the unique ID of the folder.
java.lang.String	getName() Deprecated. Returns the name of the folder.
java.lang.Long[]	getPageIds() Deprecated. Returns a list of page IDs which identify pages contained in the folder.
java.lang.Long	getParentId() Deprecated. Returns the ID of the parent folder of the folder, or null if the folder has no parent.
java.util.List<Folder>	getSubFolders() Deprecated. Returns the sub-folders of the current folder.
void	resolvePageIds(AdministrationService pas) Deprecated. Converts the parsed String UUIDs into Longs.
void	setAccessiblePages(Page[] accessiblePages) Deprecated.
void	setDescription(java.lang.String description_) Deprecated. See getDescription().
void	setId(java.lang.Long id_) Deprecated. See getId().
void	setName(java.lang.String name_) Deprecated. See getName().
void	setPageIds(java.lang.Long[] ids) Deprecated. See getPageIds().
void	setParentId(java.lang.Long id_) Deprecated. See getParentId().
void	setSubFolders(java.util.List<Folder> folders) Deprecated. See getSubFolders().

Methods inherited from class java.lang.Object

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

Constructor Detail

Folder

public Folder()

Deprecated.

Method Detail

copyNonLocalizedFieldsOnly

public Folder copyNonLocalizedFieldsOnly()

Deprecated.

Creates and returns a new Folder object. The returned object's "non-localized" fields will be set to point to this object's corresponding fields. Non-localized fields are all the fields that are not String fields holding bundle keys.

Returns:

a new Folder object.

getDescription

public java.lang.String getDescription()

Deprecated.

Returns the description of the folder.

Returns:

the description of the folder.

See Also:

setDescription(String)

setDescription

public void setDescription(java.lang.String description_)

Deprecated.

See getDescription().

Parameters:

description_ - The description of the folder.

See Also:

getDescription()

getId

public java.lang.Long getId()

Deprecated.

Returns the unique ID of the folder.

Specified by:

getId in interface LocalId

Returns:

the unique ID of the folder.

See Also:

setId(Long)

setId

public void setId(java.lang.Long id_)

Deprecated.

See getId().

Specified by:

setId in interface LocalId

Parameters:

id_ - Id to set

See Also:

getId()

getName

public java.lang.String getName()

Deprecated.

Returns the name of the folder.

Returns:

the name of the folder.

See Also:

setName(String)

setName

public void setName(java.lang.String name_)

Deprecated.

See getName().

Parameters:

name_ - The name of this folder.

See Also:

getName()

getPageIds

public java.lang.Long[] getPageIds()

Deprecated.

Returns a list of page IDs which identify pages contained in the folder.

Returns:

a list of page IDs which identify pages contained in the folder.

See Also:

setPageIds(Long[])

setPageIds

public void setPageIds(java.lang.Long[] ids)

Deprecated.

See getPageIds().

Parameters:

ids_ - An array of page IDs which identify pages contained in the folder.

See Also:

getPageIds()

getParentId

public java.lang.Long getParentId()

Deprecated.

Returns the ID of the parent folder of the folder, or null if the folder has no parent.

Returns:

the ID of the parent folder of the folder, or null if the folder has no parent.

See Also:

setParentId(Long)

setParentId

public void setParentId(java.lang.Long id_)

Deprecated.

See getParentId().

Parameters:

id_ - The parent id.

See Also:

getParentId()

getSubFolders

public java.util.List<Folder> getSubFolders()

Deprecated.

Returns the sub-folders of the current folder.

Returns:

the sub-folders of the current folder

See Also:

#setSubFolders(Folder[])

setSubFolders

public void setSubFolders(java.util.List<Folder> folders)

Deprecated.

See getSubFolders().

Parameters:

folders - An array of Folders that are the sub-folders of the current folder.

See Also:

getSubFolders()

getAccessiblePages

public Page[] getAccessiblePages()

Deprecated.

setAccessiblePages

public void setAccessiblePages(Page[] accessiblePages)

Deprecated.

resolvePageIds

public void resolvePageIds(AdministrationService pas)

Deprecated.

Converts the parsed String UUIDs into Longs.

Parameters:

pas - the service which provides the lookup