com.wewebu.ow.server.util.paramcodec
Interface OwParameterMapCodec

All Known Implementing Classes:
OwAppCounterBag, OwAttributeBagCodec, OwCookieStoreCodec, OwNetworkAttributeBagCodec, OwTransientCodec

public interface OwParameterMapCodec

Encodes and decodes OwParameterMaps.
The result of the encoding and decoding of the parameter maps are also OwParameterMaps.

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

Since:
3.0.0.0

Method Summary
 boolean canDecode(OwParameterMap parameterMap_p)
          Verifies that this codec can decode the given OwParameterMap without system-errors.
 OwParameterMap decode(OwParameterMap parameterMap_p, boolean preserveEncoding_p)
          Decodes the given OwParameterMap
 OwParameterMap encode(OwParameterMap parameterMap_p)
          Encodes the given OwParameterMap
 long getNextUnqiueNameIndex()
          Get the next available unique index.
 

Method Detail

encode

OwParameterMap encode(OwParameterMap parameterMap_p)
                      throws OwException
Encodes the given OwParameterMap

Parameters:
parameterMap_p -
Returns:
the encoded OwParameterMap
Throws:
OwException - if the encoding process fails

decode

OwParameterMap decode(OwParameterMap parameterMap_p,
                      boolean preserveEncoding_p)
                      throws OwException,
                             OwUserOperationException
Decodes the given OwParameterMap

Parameters:
parameterMap_p -
preserveEncoding_p - if true the decoded OwParameterMap will also contain the encoded parameters
Returns:
the decoded OwParameterMap
Throws:
OwException - if the decoding process fails
OwUserOperationException - if the decoding process fails but recovery is possible (non-system-errors)
egg. expired cookies in cookie based encoding scheme

canDecode

boolean canDecode(OwParameterMap parameterMap_p)
                  throws OwException
Verifies that this codec can decode the given OwParameterMap without system-errors.

Parameters:
parameterMap_p -
Returns:
true if the given OwParameterMap can be decoded or false otherwise
Throws:
OwException

getNextUnqiueNameIndex

long getNextUnqiueNameIndex()
                            throws OwException
Get the next available unique index.

Returns:
a unique long index
Throws:
OwException


Copyright © 2013 Alfresco Business Solutions. All Rights Reserved.