org.alfresco.service.cmr.repository
Interface PeriodProvider


public interface PeriodProvider

Provider API for period implementations


Nested Class Summary
static class PeriodProvider.ExpressionMutiplicity
          Period expression multiplicity
 
Method Summary
 java.lang.String getDefaultExpression()
          Get the default expression - this could be null
 java.lang.String getDisplayLabel()
          Gets the display label for the period.
 QName getExpressionDataType()
          Return the Alfresco data type QName to which the string value of the expression will be converted.
 PeriodProvider.ExpressionMutiplicity getExpressionMutiplicity()
          Is the expression required etc ...
 java.util.Date getNextDate(java.util.Date date, java.lang.String expression)
          Get the next date - the provided date + period
 java.lang.String getPeriodType()
          Get the name for the period.
 

Method Detail

getPeriodType

java.lang.String getPeriodType()
Get the name for the period.

Returns:
- period name

getDisplayLabel

java.lang.String getDisplayLabel()
Gets the display label for the period.

Returns:
display label

getNextDate

java.util.Date getNextDate(java.util.Date date,
                           java.lang.String expression)
Get the next date - the provided date + period

Parameters:
date -
expression -
Returns:
the next date in the period

getExpressionMutiplicity

PeriodProvider.ExpressionMutiplicity getExpressionMutiplicity()
Is the expression required etc ...

Returns:
the multiplicity

getDefaultExpression

java.lang.String getDefaultExpression()
Get the default expression - this could be null

Returns:
- the default expression.

getExpressionDataType

QName getExpressionDataType()
Return the Alfresco data type QName to which the string value of the expression will be converted.

Returns:
the alfresco data type or null if an expression is not allowed.


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.