com.wewebu.ow.server.field
Interface OwFormat

All Known Implementing Classes:

OwSearchCriteria, OwSearchCriteriaFieldDefOverride, OwStandardCrossMappings.OwCrossDecoratorSearchNode.OwWrappedSearchCriteria, OwStandardDecoratorSearchCriteria

public interface OwFormat

Base interface for format information for fields.

Alfresco Workdesk
Copyright (c) Alfresco Software, Inc.
All rights reserved.

For licensing information read the license.txt file or
go to: http://wiki.alfresco.com

Method Summary

boolean	canValidate() check if validation is implemented
Format	getTextFormat(int iFieldProviderType_p) get the optional formatter object for string representation, according to the given context type
boolean	ignoreDate() check if the format should ignore date part of date values
boolean	ignoreTime() check if the format should ignore time part of date values
String	validate(int iFieldProviderType_p, Object object_p, Locale locale_p) validate the given value

Method Detail

ignoreTime

boolean ignoreTime()

check if the format should ignore time part of date values

ignoreDate

boolean ignoreDate()

check if the format should ignore date part of date values

getTextFormat

Format getTextFormat(int iFieldProviderType_p)

get the optional formatter object for string representation, according to the given context type

Parameters:

iFieldProviderType_p - int as defined in OwFieldProvider.TYPE_...

Returns:

OwFormat, can be null to use the default format

canValidate

boolean canValidate()

check if validation is implemented

Returns:

a boolean

validate

String validate(int iFieldProviderType_p,
                Object object_p,
                Locale locale_p)
                throws OwInvalidOperationException

validate the given value

Parameters:

iFieldProviderType_p - int as defined in OwFieldProvider.TYPE_...

object_p - the value to validate

locale_p - Locale for String localize

Returns:

null if valid, a String user message if invalid

Throws:

OwInvalidOperationException