Package org.ametys.web.alias

Interface Alias

All Known Implementing Classes:

DefaultAlias

public interface Alias

This interface represents a alias

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	Alias.TargetType	Type of a target.

Method Summary

Modifier and Type	Method	Description
Date	getCreationDate()	Get the creation date
Date	getExpirationDate()	Get the expiration date
String	getTarget()	Get the target URL
Alias.TargetType	getType()	Retrieves the target type.
String	getUrl()	Get the origin URL
void	removeExpirationDate()	Remove the expiration date
void	setCreationDate(Date date)	Set the creation date
void	setExpirationDate(Date date)	Set the expiration date
void	setTarget(String url)	Set the target URL
void	setType(Alias.TargetType type)	Set the type.
void	setUrl(String url)	Set the origin URL

Method Details

getUrl

String getUrl()
       throws AmetysRepositoryException

Get the origin URL

Returns:

the origin URL

Throws:

AmetysRepositoryException - if an error occurs.

setUrl

void setUrl(String url)
     throws AmetysRepositoryException

Set the origin URL

Parameters:

url - the origin URL

Throws:

AmetysRepositoryException - if an error occurs.

getTarget

String getTarget()
          throws AmetysRepositoryException

Get the target URL

Returns:

the target URL

Throws:

AmetysRepositoryException - if an error occurs.

setTarget

void setTarget(String url)
        throws AmetysRepositoryException

Set the target URL

Parameters:

url - the target URL

Throws:

AmetysRepositoryException - if an error occurs.

getExpirationDate

Date getExpirationDate()
                throws AmetysRepositoryException

Get the expiration date

Returns:

the expiration date

Throws:

AmetysRepositoryException - if an error occurs.

setExpirationDate

void setExpirationDate(Date date)
                throws AmetysRepositoryException

Set the expiration date

Parameters:

date - the expiration date

Throws:

AmetysRepositoryException - if an error occurs.

removeExpirationDate

void removeExpirationDate()
                   throws AmetysRepositoryException

Remove the expiration date

Throws:

AmetysRepositoryException - if an error occurs.

getType

Alias.TargetType getType()
                  throws AmetysRepositoryException

Retrieves the target type.

Returns:

the type.

Throws:

AmetysRepositoryException - if an error occurs.

See Also:

• Alias.TargetType

setType

void setType(Alias.TargetType type)
      throws AmetysRepositoryException

Set the type.

Parameters:

type - the type.

Throws:

AmetysRepositoryException - if an error occurs.

See Also:

• Alias.TargetType

getCreationDate

Date getCreationDate()
              throws AmetysRepositoryException

Get the creation date

Returns:

the creation date

Throws:

AmetysRepositoryException - if an error occurs.

setCreationDate

void setCreationDate(Date date)
              throws AmetysRepositoryException

Set the creation date

Parameters:

date - the date to set

Throws:

AmetysRepositoryException - if an error occurs.