Package org.exoplatform.social.core.activity.model

Interface ActivityStream

All Known Implementing Classes:

ActivityStreamImpl

public interface ActivityStream

Use this class to know the stream context and its information. As defined in http://activitystrea.ms/

Since:

Nov 10, 2010

Author:

hoatle (hoatlevan at gmail dot com)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ActivityStream.Type	The type of activity stream, can be user or space.

Field Summary

Fields

Modifier and Type	Field	Description
static String	ORGANIZATION_PROVIDER_ID
static String	SPACE_PROVIDER_ID

Method Summary

Modifier and Type	Method	Description
String	getFaviconUrl()	Gets a string specifying the URL for the stream's favicon.
String	getId()	Gets stream Id (internal activityStorage).
String	getPermaLink()	Gets the link to the UI endpoint of the stream in portal.
String	getPrettyId()	Gets prettyId name.
String	getTitle()	Gets a human-readable name for this stream.
ActivityStream.Type	getType()	Gets stream type, could be Type.USER or Type.SPACE.
boolean	isSpace()
boolean	isUser()
void	setFaviconUrl(String faviconUrl)	Sets a string specifying the URL for the stream's favicon.
void	setId(String id)	Sets stream Id (internal activityStorage).
void	setPermaLink(String permaLink)	Sets the link to the UI endpoint of the stream in portal.
void	setPrettyId(String prettyId)	Sets prettyId name.
void	setTitle(String title)	Sets a human-readable name for this stream.
void	setType(String name)	Sets type (could be "space" or "user").
void	setType(ActivityStream.Type type)	Sets stream type.

Field Detail

ORGANIZATION_PROVIDER_ID

static final String ORGANIZATION_PROVIDER_ID

See Also:

Constant Field Values

SPACE_PROVIDER_ID

static final String SPACE_PROVIDER_ID

See Also:

Constant Field Values

Method Detail

setType

void setType(String name)

Sets type (could be "space" or "user").

Parameters:

name - the type name

getId

String getId()

Gets stream Id (internal activityStorage).

Returns:

stream uuid

setId

void setId(String id)

Sets stream Id (internal activityStorage).

Parameters:

id - the uuid of published-node

getPrettyId

String getPrettyId()

Gets prettyId name. Can be: "root" or "space_abc".

Returns:

pretty id

setPrettyId

void setPrettyId(String prettyId)

Sets prettyId name.

Parameters:

prettyId - the prettyId name

getType

ActivityStream.Type getType()

Gets stream type, could be Type.USER or Type.SPACE.

Returns:

the Type of ActivityManager

setType

void setType(ActivityStream.Type type)

Sets stream type.

Parameters:

type - the Type of ActivityManager

getFaviconUrl

String getFaviconUrl()

Gets a string specifying the URL for the stream's favicon.

Returns:

the favicon Url

setFaviconUrl

void setFaviconUrl(String faviconUrl)

Sets a string specifying the URL for the stream's favicon.

Parameters:

faviconUrl - the favicon Url

getTitle

String getTitle()

Gets a human-readable name for this stream. This property MAY be null if the stream has no title or name.

Returns:

the stream's title

setTitle

void setTitle(String title)

Sets a human-readable name for this stream. This property MAY be null if the stream has no title or name.

Parameters:

title - the stream title

getPermaLink

String getPermaLink()

Gets the link to the UI endpoint of the stream in portal.
A string specifying the stream's URL

Returns:

the permanent link for this activity stream

setPermaLink

void setPermaLink(String permaLink)

Sets the link to the UI endpoint of the stream in portal.
A string specifying the stream's URL

Parameters:

permaLink - the permanent link for this activity stream

isSpace

boolean isSpace()

Returns:

true if Stream is of Space type

isUser

boolean isUser()

Returns:

true if Stream is of User type