Package pt.ptcris

Class PTCRISyncResult<E extends org.um.dsi.gavea.orcid.model.common.ElementSummary>

java.lang.Object

pt.ptcris.PTCRISyncResult<E>

public final class PTCRISyncResult<E extends org.um.dsi.gavea.orcid.model.common.ElementSummary>
extends java.lang.Object

A class that encapsulates the result of the synchronization procedures for a particular activity. Currently only the export methods report these results.

Field Summary

Fields

Modifier and Type	Field	Description
E	act
static int	ADDOK
static int	CLIENTERROR
int	code
static int	DELETEOK
java.lang.Exception	exception
static int	GETOK
static int	INVALID
java.math.BigInteger	putcode
static int	UPDATEOK
static int	UPTODATE

Method Summary

Modifier and Type	Method	Description
static <E extends org.um.dsi.gavea.orcid.model.common.ElementSummary> PTCRISyncResult<E>	fail(org.um.dsi.gavea.orcid.client.exception.OrcidClientException exception)	Creates message reporting a failure at the ORCID API level.
static <E extends org.um.dsi.gavea.orcid.model.common.ElementSummary> PTCRISyncResult<E>	invalid(InvalidActivityException exception)	Creates message reporting an invalid activity.
static <E extends org.um.dsi.gavea.orcid.model.common.ElementSummary> PTCRISyncResult<E>	ok_add(java.math.BigInteger putcode)	Creates a successful "add" message with the assigned put-code.
static <E extends org.um.dsi.gavea.orcid.model.common.ElementSummary> PTCRISyncResult<E>	ok_del()	Creates a successful "delete" message.
static <E extends org.um.dsi.gavea.orcid.model.common.ElementSummary> PTCRISyncResult<E>	ok_get(java.math.BigInteger putcode, E element)	Creates a successful "get" message with the assigned put-code.
static <E extends org.um.dsi.gavea.orcid.model.common.ElementSummary> PTCRISyncResult<E>	ok_upd()	Creates a successful "update" message.
static <E extends org.um.dsi.gavea.orcid.model.common.ElementSummary> PTCRISyncResult<E>	uptodate()	Creates an "already up-to-date" message.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

GETOK

public static final int GETOK

See Also:

Constant Field Values

ADDOK

public static final int ADDOK

See Also:

Constant Field Values

UPDATEOK

public static final int UPDATEOK

See Also:

Constant Field Values

DELETEOK

public static final int DELETEOK

See Also:

Constant Field Values

UPTODATE

public static final int UPTODATE

See Also:

Constant Field Values

INVALID

public static final int INVALID

See Also:

Constant Field Values

CLIENTERROR

public static final int CLIENTERROR

See Also:

Constant Field Values

code

public final int code

exception

public final java.lang.Exception exception

putcode

public final java.math.BigInteger putcode

act

public final E extends org.um.dsi.gavea.orcid.model.common.ElementSummary act

Method Detail

ok_get

public static <E extends org.um.dsi.gavea.orcid.model.common.ElementSummary> PTCRISyncResult<E> ok_get(java.math.BigInteger putcode,
                                                                                                       E element)

Creates a successful "get" message with the assigned put-code.

Type Parameters:

E - the activity type

Parameters:

putcode - the put-code of the get request

element - the retrieved activity

Returns:

an OK get message

ok_add

public static <E extends org.um.dsi.gavea.orcid.model.common.ElementSummary> PTCRISyncResult<E> ok_add(java.math.BigInteger putcode)

Creates a successful "add" message with the assigned put-code.

Type Parameters:

E - the activity type

Parameters:

putcode - the put-code of the newly added activity

Returns:

an OK add message

ok_upd

public static <E extends org.um.dsi.gavea.orcid.model.common.ElementSummary> PTCRISyncResult<E> ok_upd()

Creates a successful "update" message.

Type Parameters:

E - the activity type

Returns:

an OK update message

ok_del

public static <E extends org.um.dsi.gavea.orcid.model.common.ElementSummary> PTCRISyncResult<E> ok_del()

Creates a successful "delete" message.

Type Parameters:

E - the activity type

Returns:

an OK delete message

uptodate

public static <E extends org.um.dsi.gavea.orcid.model.common.ElementSummary> PTCRISyncResult<E> uptodate()

Creates an "already up-to-date" message.

Type Parameters:

E - the activity type

Returns:

an already up to date message

fail

public static <E extends org.um.dsi.gavea.orcid.model.common.ElementSummary> PTCRISyncResult<E> fail(org.um.dsi.gavea.orcid.client.exception.OrcidClientException exception)

Creates message reporting a failure at the ORCID API level.

Type Parameters:

E - the activity type

Parameters:

exception - the ORCID client exception

Returns:

the resulting message

invalid

public static <E extends org.um.dsi.gavea.orcid.model.common.ElementSummary> PTCRISyncResult<E> invalid(InvalidActivityException exception)

Creates message reporting an invalid activity.

Type Parameters:

E - the activity type

Parameters:

exception - the reasons for invalidity

Returns:

the resulting message