org.alfresco.mobile.android.api.model.impl

Class SiteImpl

java.lang.Object

org.alfresco.mobile.android.api.model.impl.SiteImpl

All Implemented Interfaces:

Serializable, Site

public class SiteImpl
extends Object
implements Site

Provides informations about Alfresco Share site.
A site is a project area where you can share content and collaborate with other site members.
Each site has a visibility setting that marks the site as public or private.

Author:

Jean Marie Pascal

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SiteImpl() Default constructor.
SiteImpl(Site site, boolean isPendingMember, boolean isMember, boolean isFavorite) Constructor of SiteImpl.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getDescription() Returns the description of the site.
String	getGUID() Returns a globally unique identifier for the site.
String	getIdentifier() Returns the unique identifier of the site.
String	getShortName() Returns the short name of the site.
String	getTitle() Returns the unique identifier of the site.
SiteVisibility	getVisibility() Returns the visibility of the site i.e.
boolean	isFavorite()
boolean	isMember()
boolean	isPendingMember()
static SiteImpl	parseCompatJson(Map<String,Object> json)
static SiteImpl	parseJson(Map<String,Object> json) Parse Json Response from Alfresco REST API to create a Site.
static SiteImpl	parsePublicAPIJson(Map<String,Object> json) Parse Json Response from Alfresco Public API to create a Site.

Methods inherited from class java.lang.Object

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

Constructor Detail

SiteImpl

public SiteImpl()

Default constructor.

SiteImpl

public SiteImpl(Site site,
        boolean isPendingMember,
        boolean isMember,
        boolean isFavorite)

Constructor of SiteImpl.

Parameters:

site - : site to update.

isPendingMember - : value of pending member.

isMember - : if user is member of

isFavorite - : if user has favorite the site

Method Detail

parseJson

public static SiteImpl parseJson(Map<String,Object> json)

Parse Json Response from Alfresco REST API to create a Site.

Parameters:

json - : json response that contains data from the repository

Returns:

Site object that contains essential information about it.

parseCompatJson

public static SiteImpl parseCompatJson(Map<String,Object> json)

parsePublicAPIJson

public static SiteImpl parsePublicAPIJson(Map<String,Object> json)

Parse Json Response from Alfresco Public API to create a Site.

Parameters:

json - : json response that contains data from the repository

Returns:

Site object that contains essential information about it.

getDescription

public String getDescription()

Returns the description of the site.

Specified by:

getDescription in interface Site

Returns:

the description

getShortName

public String getShortName()

Returns the short name of the site.

Specified by:

getShortName in interface Site

Returns:

the short name

getVisibility

public SiteVisibility getVisibility()

Returns the visibility of the site i.e. “public”, “moderated” or “private”, represented by an enum.

Specified by:

getVisibility in interface Site

Returns:

the visibility

getTitle

public String getTitle()

Returns the unique identifier of the site.

Specified by:

getTitle in interface Site

Returns:

the title

getIdentifier

public String getIdentifier()

Returns the unique identifier of the site.

Specified by:

getIdentifier in interface Site

Returns:

the identifier

getGUID

public String getGUID()

Returns a globally unique identifier for the site.

Specified by:

getGUID in interface Site

Returns:

GUID of the site

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

isMember

public boolean isMember()

Specified by:

isMember in interface Site

Returns:

true if the current user is a member of the site.

isPendingMember

public boolean isPendingMember()

Specified by:

isPendingMember in interface Site

Returns:

true if the current user has requested to join the site. If the site is not moderated this will return false.

isFavorite

public boolean isFavorite()

Specified by:

isFavorite in interface Site

Returns:

true if the current user has favorited the site.